PriceBase

  • active
    Type: boolean

    Whether the price can be used for new purchases.

  • billing_scheme
    Type: stringenum

    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.

    values
    • per_unit
    • tiered
  • created
    nullable

    Time at which the object was created. Measured in seconds since the Unix epoch.

  • currency
    Type: stringFormat: currency

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • livemode
    Type: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • lookup_key
    Type: string | null
    max length:  
    5000

    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

  • product
    • Type: string · ProductId
      max length:  
      100

      The ID of the product this price is associated with.

  • product_data

    These fields can be used to create a new product that this price will belong to.

    • name
      Type: string
      max length:  
      5000
      required

      The product's name, meant to be displayable to the customer.

    • active
      Type: boolean

      Whether the product is currently available for purchase. Defaults to true.

    • description
      Type: string
      max length:  
      40000

      The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

    • id
      Type: string
      max length:  
      5000

      An identifier will be randomly generated by Paypercut. You can optionally override this ID, but the ID must be unique across all products in your Paypercut account.

    • unit_label
      Type: string
      max length:  
      12

      A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.

  • recurring
    Type: object · Recurring nullable
    • interval
      Type: stringenum
      required

      The frequency at which a subscription is billed. One of day, week, month or year.

      values
      • day
      • month
      • week
      • year
    • interval_count
      Type: integer
      required

      The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.

    • usage_type
      Type: stringenum
      required

      Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.

      values
      • licensed
      • metered
    • meter
      Type: string | null
      max length:  
      5000

      The meter tracking the usage of a metered price

  • type
    Type: stringenum

    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

    values
    • one_time
    • recurring
  • unit_amount
    Type: integer | null

    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.

  • unit_amount_decimal
    Type: string | nullFormat: decimal

    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.