checkouts

Create a checkout

Creates a checkout link that generates a URL for a customer to complete a purchase

post/checkouts/

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/checkouts/
  • Auth: HTTP bearer

Request body

customerIdstring
externalCustomerIdstring

External customer identifier. Creates the customer on first use, resolves to the existing customer on subsequent uses.

successUrlstring uri required
cancelUrlstring uri
expiresAtstring date-time
metadataobject
collectAddressboolean
collectPhoneboolean
singleUseboolean
currencystring

Lock checkout to a specific currency. Omit to allow all currencies supported by the selected plans. If the checkout is for a customer with an active subscription, the currency must match that subscription's currency — subscriptions cannot change currency.

Response

201

idstring required
urlstring required
status'active' | 'completed' | 'expired' | 'archived' required
customerIdstring nullable required
externalCustomerIdstring nullable required
successUrlstring required
cancelUrlstring nullable required
expiresAtstring date-time nullable required
metadataobject nullable required
collectAddressboolean required
collectPhoneboolean required
singleUseboolean required
allowedCurrenciesstring[] required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.