Checkout

Checkout session for processing payments

  • created
    Type: stringFormat: date-time
    required

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

  • expires_at
    Type: stringFormat: date-time
    required

    Expiry time for the checkout. After this time, the checkout will no longer be available for payment. Defaults to 24h after creation.

  • id
    Type: string
    required

    Unique identifier for the checkout session

  • payment_status
    Type: stringenum
    required

    The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required. You can use this value to decide when to fulfill your customer's order.

    values
    • no_payment_required
    • paid
    • unpaid
  • url
    Type: stringFormat: uri
    required

    URL where the customer can complete the payment

  • amount
    Type: integer · amountWithCurrencyPrecisionFormat: int64

    Integer amount in minor units (e.g. cents) specific to the currency. Example: 100 for €1.00

  • client_customer_id
    Type: string

    An identifier of the customer in the merchant's system. Used to associate the Checkout and corresponding payments created from the Checkout. Required for SEPA payments - this will ensure that your customer is given a virtual iban that is unique to them and will enable Paypercut to reconcile the payment.

  • client_reference_id
    Type: string

    A free-form reference from the merchant's system. Typically used to identify the checkout in the merchant's system. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.

  • currency
    Type: object · Currency

    Three-letter ISO currency code

    • iso
      Type: string
      required

      Three-letter ISO currency code

    • scale
      Type: integer
      required

      Number of decimal places for this currency

  • description
    Type: string

    A free-form reference to describe the checkout

  • line_items
    Type: array object[] · LineItem[]

    Details about the products sold or services provided

    • quantity
      Type: integerFormat: int64
      min:  
      1
      max:  
      10000000000
      required

      Quantity of the item

    • metadata

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

      • propertyName
        Type: string
    • price_data

      Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.

      • 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
        Type: integerFormat: date-time 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.

      • id
        Type: string
        max length:  
        5000

        Unique identifier for the object.

      • 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
      • product_data
        Type: object · Product

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

      • recurring
        Type: object · Recurring nullable
      • 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.

  • on_behalf_of
    Type: string

    Account ID to which the payment will be credited

  • payment_method_configuration
    Type: string

    Reference to a payment profile specifying the payment methods which should be available on the Checkout and their configurations. Required if more than one payment profile exists.

  • status
    Type: string | nullenum

    The status of the Checkout Session, one of open, complete, or expired.

    values
    • complete
    • expired
    • open