v1

latestOpenAPI 3.0.02026-07-1498163181.9 KB

Checkout Sessions

Complete checkout session with incomplete payment

post/api/v1/checkout/sessions/{id}/complete-partial-checkout-session

Path parameters

idstring required

Response

idstring required

createdAtstring date-time

updatedAtstring date-time

organizationIdstring required

Organization id of the checkout session

mode'payment' | 'subscription'

paymentLinkIdstring uuid

The payment link id used to create this checkout session

subscriptionIdstring uuid

The subscription created from this checkout session

invoiceIdstring uuid

The invoice created from this checkout session

amountTotalinteger required

A non-zero amount filled in with 8 decimal places. For example, 1 USDC is 100000000.

amountSubtotalinteger required

Amount subtotal is total of all line items excluding tax, shipping, application fee and discount. A non-zero amount filled in with 8 decimal places. For example, 1 USDC is 100000000.

amountGasFeeinteger

Amount fee is extra amount on top of amountSubtotal. If charged from end user.

amountFeeinteger

Amount fee is extra amount on top of amountSubtotal. If charged from end user.

amountNetinteger

paymentMethodTypesPaymentMethodType[]

A list of the types of payment methods (e.g. wallet) this Checkout Session is allowed to accept.

status'open' | 'complete' | 'incomplete' | 'expired' required

paymentStatus'unpaid' | 'paid' required

expiresAtstring date-time

The time at which the session will expire. Default: 1 Hour

customerIdstring

The ID of the customer if you want to associate the session with a customer

clientReferenceIdstring

Unique ID string used to identify the session in your backend. This can be your payment ID, cart ID, or similar used to link this Checkout Session with your internal system.

customerCreation'if_required' | 'always'

urlstring required

The URL to redirect the customer to complete payment

successUrlstring

The URL to redirect the customer to after payment is completed. Only applicable when afterCompletion is set to redirect

cancelUrlstring

The URL to redirect the customer to if they decide to cancel payment

submitType'pay' | 'book' | 'donate'

metadataobject

A set of key-value pairs that you can attach to a Checkout Session object

nameCollectionboolean

Whether to collect the customer's name. Default: false

emailCollectionboolean

Whether to collect the customer's email address. Default: false

phoneNumberCollectionboolean

Whether to collect the customer's phone number Default: false

shippingAddressCollectionboolean

Whether to collect the customer's shipping address. Default: false

billingAddressCollectionboolean

Whether to collect the customer's billing address. Default: false

afterCompletion'redirect' | 'hosted_confirmation'

afterCompletionConfirmMsgstring

The message to show after successful payment. Only applicable when afterCompletion is set to hosted_confirmation

isMarkRefundedboolean

Whether to mark the payment as refunded

allowPromotionCodesboolean

Enables user redeemable promotion codes.

defaultPromotionCodestring

The default promotion code to apply to the session

isManualPaymentboolean required

Example response

{
  "paymentLinkId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
  "subscriptionId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
  "invoiceId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
  "amountTotal": 100000000,
  "amountSubtotal": 100000000,
  "amountDetails": {
    "feePercentage": 1
  },
  "paymentSetting": {
    "allowedChains": [
      {
        "chainId": 137
      }
    ],
    "preferredChainId": 1
  },
  "customer": {
    "id": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
    "taxIds": {
      "data": [
        {
          "customerId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
        }
      ]
    }
  },
  "customerDetails": {
    "taxIds": {
      "data": [
        {
          "customerId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
        }
      ]
    }
  },
  "customFields": {
    "fields": [
      {
        "text": {
          "maximumLength": 1,
          "minimumLength": 1
        },
        "numeric": {
          "maximumLength": 1,
          "minimumLength": 1
        }
      }
    ]
  },
  "lineItems": {
    "data": [
      {
        "quantity": 1,
        "price": {
          "productId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
          "intervalCount": 1,
          "product": {
            "defaultPriceId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
          }
        },
        "taxRates": [
          {
            "percentage": 1
          }
        ]
      }
    ]
  },
  "addresses": [
    {
      "asset": {
        "chainId": 1,
        "decimals": 1,
        "superToken": {
          "decimals": 1
        },
        "chain": {
          "id": 1
        }
      }
    }
  ],
  "paymentIntent": {
    "organizationId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
    "paymentMethodId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
    "paymentMethod": {
      "assetId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
      "asset": {
        "chainId": 1,
        "decimals": 1,
        "superToken": {
          "decimals": 1
        }
      },
      "customerId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
    },
    "transactions": [
      {
        "nonce": 1,
        "gasLimit": 1,
        "asset": {
          "chainId": 1,
          "decimals": 1,
          "superToken": {
            "decimals": 1
          },
          "chain": {
            "id": 1
          }
        }
      }
    ],
    "paymentReceipt": {
      "organizationId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
      "paymentIntentId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
    }
  },
  "discounts": [
    {
      "coupon": {
        "percentOff": 1
      }
    }
  ]
}