Skip to content
Creative Payments

API reference

Every endpoint of the REST API with its parameters, responses and examples, followed by the objects they use.

On this page

Overview

Create payments, read them back and cancel them. Authenticate every request with an API key: Authorization: Bearer cp_live_... or cp_test_.... A test key works on test payments only (no real money moves) and a live key on live ones; the two never see each other. Amounts are decimal strings in major units, never numbers. amount and currency of a payment are the price you set; charge is what the buyer is charged: for a price in USD the EUR total, converted at the ECB euro reference rate with the rate and its day given, and for a price in EUR the same amount at rate "1". charge.amount is the TOTAL the buyer pays, VAT included; charge.net_amount is the price before VAT (converted to EUR for a USD price) and charge.vat_amount the VAT. A payment that gets an invoice has no VAT until the buyer has given their billing details at checkout and confirmed the total: until then charge.amount equals charge.net_amount and vat_amount is "0.00". Your fee and your payout never include VAT. fee is expressed in the charge currency (EUR), while amount and currency are the price as sent: for a payment priced in USD, amount minus fee mixes two currencies, so work from charge.net_amount and fee (both in charge.currency). If no recent rate is available, creating a payment priced in USD fails with 503 fx_unavailable. Errors always have the shape { "error": { "code", "message", "param"? } }. Every response carries an X-Request-Id header.

Payments

List payments

GET/api/v1/payments

The payments of the mode of your API key (a test key lists test payments, a live key live ones), newest first.

Parameters
NameInTypeDescription
limitqueryintegerHow many payments to return.
starting_afterquerystringThe id of the last payment of the previous page. Returns the payments created before it.
Responses
StatusBodyDescription
200PaymentListA page of payments.
400ErrorThe request is not valid: malformed JSON (invalid_json), a field that fails validation (invalid_request, with the field in param), a value the payment rules refuse after that validation, such as the description, the return URL, the metadata or a list limit (invalid_input, the message says which rule), an amount that is not a decimal string (invalid_amount), a bad Idempotency-Key (invalid_idempotency_key) or a bad starting_after (invalid_cursor).
401ErrorThe API key is missing, malformed, unknown or revoked, or its account is suspended. The reason is deliberately not given.
429ErrorToo many requests: 120 per minute per API key, and a per-address limit in front of it.
500ErrorSomething went wrong on our side. Nothing was changed by a request with an Idempotency-Key, so it is safe to retry it.
Requestcurl
curl -sS "https://payments.example.com/api/v1/payments" \
  -H "Authorization: Bearer cp_test_..."
Response 200JSON
{
  "object": "list",
  "data": [
    {
      "id": "pay_0123456789abcdefghjkmnpq",
      "object": "payment",
      "status": "created",
      "amount": "49.00",
      "currency": "EUR",
      "charge": {
        "amount": "49.00",
        "currency": "EUR",
        "fx_rate": "1",
        "fx_date": null,
        "net_amount": "49.00",
        "vat_amount": "0.00"
      },
      "provider_charge": null,
      "fee": "1.13",
      "description": "Order 42",
      "metadata": {
        "order_id": "42"
      },
      "checkout_url": "https://payments.example.com/pay/3vQB7B6MrGQHehYtG8JNQSjQdXbNUjpkLUWGDKvvQdk",
      "livemode": false,
      "method": null,
      "created": "2026-11-06T12:00:00.000Z",
      "expires_at": "2026-11-07T12:00:00.000Z",
      "paid_at": null,
      "subscription_id": null
    },
    {
      "id": "pay_9876543210zyxwvtsrqpnmkh",
      "object": "payment",
      "status": "created",
      "amount": "49.00",
      "currency": "USD",
      "charge": {
        "amount": "43.78",
        "currency": "EUR",
        "fx_rate": "1.1193",
        "fx_date": "2026-11-05",
        "net_amount": "43.78",
        "vat_amount": "0.00"
      },
      "provider_charge": null,
      "fee": "1.03",
      "description": "Order 43",
      "metadata": {
        "order_id": "43"
      },
      "checkout_url": "https://payments.example.com/pay/Qx7mT0wZk3VnYb2LhJcPdRsAeUfGiO9XtNq4BvM8yKc",
      "livemode": false,
      "method": null,
      "created": "2026-11-06T12:05:00.000Z",
      "expires_at": "2026-11-07T12:05:00.000Z",
      "paid_at": null,
      "subscription_id": null
    }
  ],
  "has_more": false
}

Create a payment

POST/api/v1/payments

Creates a payment and returns it with a checkout_url: send the buyer there to choose a method and pay. Send an Idempotency-Key to make a retry safe: the same key with the same body returns the first response (marked Idempotent-Replayed: true) and creates no second payment; the same key with a different body is refused with 422. Keys are kept for 24 hours.

Parameters
NameInTypeDescription
Idempotency-KeyheaderstringMakes a retry safe. 1 to 200 characters of letters, digits and _ . : -. Scoped to your account and mode; kept for 24 hours. A replay returns the stored first response as it was: a key stored before charge was added replays a payment without charge until it expires.
Request body (CreatePaymentRequest), required
FieldTypeDescription
amountrequiredstringThe price as a decimal string in major units, for example "49.00". At most 2 decimals.
currencyrequired"EUR" | "USD"The currency the payment is priced in. The buyer is charged in EUR (except BLIK, TWINT, Swish and Vipps, which charge the plain ECB amount in PLN, CHF, SEK or NOK: see provider_charge): a USD price is converted at the latest ECB euro reference rate, rounded half up to the cent.
descriptionrequiredstringWhat the payment is for. Shown to the buyer.
return_urlrequiredstring (uri)Where the buyer is sent after the checkout. An http(s) URL without credentials.
expires_in_minutesintegerHow many minutes the payment stays payable: a whole number from 1 to 1440. After that time the payment expires and can no longer be paid. Absent: 1440 (24 hours). A method with its own payment window (Multibanco, bank transfer, a cash voucher) moves the expiry to the pick time plus that window, as before.
metadataobjectYour own string key-value pairs, returned unchanged on the payment.
linesarray of objectThe order lines, for the pay-later methods. Their totals must add up to amount. Only for payments made with your own provider keys. Write-only: never returned.
lines[].descriptionrequiredstringWhat the line is. Shown to the buyer by the payment provider.
lines[].quantityrequiredintegerHow many units. A whole number, at least 1.
lines[].unit_pricerequiredstringThe price of one unit as a decimal string in the payment currency.
lines[].total_amountrequiredstringThe line total: unit_price times quantity minus discount_amount. The totals of all lines must add up to the payment amount.
lines[].discount_amountstringA discount on the whole line, as a decimal string.
lines[].vat_ratestringThe VAT rate in percent, for example "21.00", included in the line total.
lines[].skustringYour stock keeping unit for the line.
lines[].type"physical" | "digital" | "shipping_fee" | "discount" | "store_credit" | "gift_card" | "surcharge" | "tip"The kind of line.
lines[].categoriesarray of "eco" | "gift" | "meal" | "sport_culture" | "additional" | "consume"Voucher categories the line belongs to (meal and eco vouchers).
billing_addressobjectThe buyer billing address, for the pay-later methods. Only for payments made with your own provider keys. Write-only: never returned.
billing_address.given_namerequiredstringGiven name, 2 to 100 characters.
billing_address.family_namerequiredstringFamily name, 2 to 100 characters.
billing_address.organization_namestringCompany name, up to 200 characters.
billing_address.street_and_numberrequiredstringStreet and house number, 2 to 200 characters.
billing_address.street_additionalstringAdditional address line, up to 200 characters.
billing_address.postal_coderequiredstringPostal code, up to 20 characters.
billing_address.cityrequiredstringCity, up to 100 characters.
billing_address.regionstringRegion or state, up to 100 characters.
billing_address.countryrequiredstringISO 3166-1 alpha-2 country code, for example "PT".
billing_address.phonestringPhone number in international format, for example "+351912345678".
billing_address.emailrequiredstringThe buyer email address.
shipping_addressobjectThe delivery address; needs billing_address. Only for payments made with your own provider keys. Write-only: never returned.
shipping_address.given_namerequiredstringGiven name, 2 to 100 characters.
shipping_address.family_namerequiredstringFamily name, 2 to 100 characters.
shipping_address.organization_namestringCompany name, up to 200 characters.
shipping_address.street_and_numberrequiredstringStreet and house number, 2 to 200 characters.
shipping_address.street_additionalstringAdditional address line, up to 200 characters.
shipping_address.postal_coderequiredstringPostal code, up to 20 characters.
shipping_address.cityrequiredstringCity, up to 100 characters.
shipping_address.regionstringRegion or state, up to 100 characters.
shipping_address.countryrequiredstringISO 3166-1 alpha-2 country code, for example "PT".
shipping_address.phonestringPhone number in international format, for example "+351912345678".
shipping_address.emailstringThe recipient email address.
Responses
StatusBodyDescription
201PaymentThe payment. For a replay it is the stored first response.
400ErrorThe request is not valid: malformed JSON (invalid_json), a field that fails validation (invalid_request, with the field in param), a value the payment rules refuse after that validation, such as the description, the return URL, the metadata or a list limit (invalid_input, the message says which rule), an amount that is not a decimal string (invalid_amount), a bad Idempotency-Key (invalid_idempotency_key) or a bad starting_after (invalid_cursor).
401ErrorThe API key is missing, malformed, unknown or revoked, or its account is suspended. The reason is deliberately not given.
403ErrorThe account cannot take payments: it is suspended, or its type does not support the API.
413ErrorThe request body is larger than 32 KB.
415ErrorThe Content-Type is not application/json.
422ErrorThe request is well formed but cannot be done: no payment method is available for this amount and currency (no_methods), fees are not configured for the account (no_fee_rule), the amount does not cover the fee, or a USD price is less than one euro cent (amount_too_small), or the Idempotency-Key was used with a different request (idempotency_key_reuse).
429ErrorToo many requests: 120 per minute per API key, and a per-address limit in front of it.
500ErrorSomething went wrong on our side. Nothing was changed by a request with an Idempotency-Key, so it is safe to retry it.
503ErrorA USD price cannot be converted to EUR right now because no recent ECB euro reference rate is available (fx_unavailable). Nothing was created; retry after the time in Retry-After, with the same Idempotency-Key if you sent one. EUR prices are never affected.
Requestcurl
curl -sS -X POST "https://payments.example.com/api/v1/payments" \
  -H "Authorization: Bearer cp_test_..." \
  -H "Idempotency-Key: order-42-attempt-1" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "49.00",
    "currency": "EUR",
    "description": "Order 42",
    "return_url": "https://shop.example.com/thanks",
    "metadata": {
      "order_id": "42"
    }
  }'
Response 201JSON
{
  "id": "pay_0123456789abcdefghjkmnpq",
  "object": "payment",
  "status": "created",
  "amount": "49.00",
  "currency": "EUR",
  "charge": {
    "amount": "49.00",
    "currency": "EUR",
    "fx_rate": "1",
    "fx_date": null,
    "net_amount": "49.00",
    "vat_amount": "0.00"
  },
  "provider_charge": null,
  "fee": "1.13",
  "description": "Order 42",
  "metadata": {
    "order_id": "42"
  },
  "checkout_url": "https://payments.example.com/pay/3vQB7B6MrGQHehYtG8JNQSjQdXbNUjpkLUWGDKvvQdk",
  "livemode": false,
  "method": null,
  "created": "2026-11-06T12:00:00.000Z",
  "expires_at": "2026-11-07T12:00:00.000Z",
  "paid_at": null,
  "subscription_id": null
}

Retrieve a payment

GET/api/v1/payments/{id}

Parameters
NameInTypeDescription
idrequiredpathstringThe payment id, pay_ followed by 24 characters.
Responses
StatusBodyDescription
200PaymentThe payment.
401ErrorThe API key is missing, malformed, unknown or revoked, or its account is suspended. The reason is deliberately not given.
404ErrorNo such payment in the mode of your API key. A payment that belongs to someone else, one of the other mode and an id of the wrong shape all look the same.
429ErrorToo many requests: 120 per minute per API key, and a per-address limit in front of it.
500ErrorSomething went wrong on our side. Nothing was changed by a request with an Idempotency-Key, so it is safe to retry it.
Requestcurl
curl -sS "https://payments.example.com/api/v1/payments/pay_0123456789abcdefghjkmnpq" \
  -H "Authorization: Bearer cp_test_..."
Response 200JSON
{
  "id": "pay_0123456789abcdefghjkmnpq",
  "object": "payment",
  "status": "created",
  "amount": "49.00",
  "currency": "EUR",
  "charge": {
    "amount": "49.00",
    "currency": "EUR",
    "fx_rate": "1",
    "fx_date": null,
    "net_amount": "49.00",
    "vat_amount": "0.00"
  },
  "provider_charge": null,
  "fee": "1.13",
  "description": "Order 42",
  "metadata": {
    "order_id": "42"
  },
  "checkout_url": "https://payments.example.com/pay/3vQB7B6MrGQHehYtG8JNQSjQdXbNUjpkLUWGDKvvQdk",
  "livemode": false,
  "method": null,
  "created": "2026-11-06T12:00:00.000Z",
  "expires_at": "2026-11-07T12:00:00.000Z",
  "paid_at": null,
  "subscription_id": null
}

Cancel a payment

POST/api/v1/payments/{id}/cancel

Cancels a payment that has not been paid: a created one, and a pending one. A pending payment that exists at its provider is canceled there first, and the local payment follows. A payment in a final status (paid, paid_late, failed, expired, canceled) is refused with 409 not_cancellable, and so is a pending payment at a provider without a cancel (Payssion). A 502 provider_error means the provider could not be reached: nothing changed locally, the payment is still pending, and the call is safe to repeat after the Retry-After seconds. A canceled payment answers the payment.failed webhook event with reason: "canceled". The request takes no body.

Parameters
NameInTypeDescription
idrequiredpathstringThe payment id, pay_ followed by 24 characters.
Responses
StatusBodyDescription
200PaymentThe payment after the cancel attempt: canceled, or its status if it moved in the meantime (a webhook can have paid it after the provider canceled it).
401ErrorThe API key is missing, malformed, unknown or revoked, or its account is suspended. The reason is deliberately not given.
404ErrorNo such payment in the mode of your API key. A payment that belongs to someone else, one of the other mode and an id of the wrong shape all look the same.
409ErrorThe payment cannot be canceled (not_cancellable): it is already in a final status (paid, paid_late, failed, expired, canceled), or it is pending at a provider that has no cancel (a Payssion payment). Nothing changed; the payment stays as it is.
429ErrorToo many requests: 120 per minute per API key, and a per-address limit in front of it.
500ErrorSomething went wrong on our side. Nothing was changed by a request with an Idempotency-Key, so it is safe to retry it.
502ErrorThe payment provider could not be reached while canceling the payment (provider_error). Nothing changed locally: the payment is still pending and the cancel is safe to repeat after the time in Retry-After.
Requestcurl
curl -sS -X POST "https://payments.example.com/api/v1/payments/pay_0123456789abcdefghjkmnpq/cancel" \
  -H "Authorization: Bearer cp_test_..."
Response 200JSON
{
  "id": "pay_0123456789abcdefghjkmnpq",
  "object": "payment",
  "status": "created",
  "amount": "49.00",
  "currency": "EUR",
  "charge": {
    "amount": "49.00",
    "currency": "EUR",
    "fx_rate": "1",
    "fx_date": null,
    "net_amount": "49.00",
    "vat_amount": "0.00"
  },
  "provider_charge": null,
  "fee": "1.13",
  "description": "Order 42",
  "metadata": {
    "order_id": "42"
  },
  "checkout_url": "https://payments.example.com/pay/3vQB7B6MrGQHehYtG8JNQSjQdXbNUjpkLUWGDKvvQdk",
  "livemode": false,
  "method": null,
  "created": "2026-11-06T12:00:00.000Z",
  "expires_at": "2026-11-07T12:00:00.000Z",
  "paid_at": null,
  "subscription_id": null
}

List payment methods for an amount

GET/api/v1/payment-methods

The methods enabled for your account and mode (a test key lists the methods of test payments) for one amount, in the order we show them, with a label and a logo. Show them in your own picker, then start the payment for the one the buyer picks with POST /v1/payments/{id}/method. A method listed here can still be refused at selection for a particular payment (an invoiced payment, order lines, the buyer country), so handle the 4xx answer of that call. code is the value to send as method; gateway groups methods of the same provider.

Parameters
NameInTypeDescription
currencyrequiredquery"EUR" | "USD"The currency of the amount: EUR or USD.
amountrequiredquerystringThe amount in major units as a decimal string, for example 49.00, the same format as the amount of a payment: at most 9 whole digits and 2 decimals.
Responses
StatusBodyDescription
200PaymentMethodListThe methods for this amount. An empty list means none is enabled for it.
400ErrorThe request is not valid: malformed JSON (invalid_json), a field that fails validation (invalid_request, with the field in param), a value the payment rules refuse after that validation, such as the description, the return URL, the metadata or a list limit (invalid_input, the message says which rule), an amount that is not a decimal string (invalid_amount), a bad Idempotency-Key (invalid_idempotency_key) or a bad starting_after (invalid_cursor).
401ErrorThe API key is missing, malformed, unknown or revoked, or its account is suspended. The reason is deliberately not given.
429ErrorToo many requests: 120 per minute per API key, and a per-address limit in front of it.
Requestcurl
curl -sS "https://payments.example.com/api/v1/payment-methods?currency=EUR&amount=49.00" \
  -H "Authorization: Bearer cp_test_..."
Response 200JSON
{
  "object": "list",
  "data": [
    {
      "object": "payment_method",
      "code": "mollie:ideal",
      "gateway": "mollie",
      "label": "iDEAL",
      "logo_url": "https://payments.example.com/method-logos/mollie-ideal.svg",
      "charge_currency": null
    },
    {
      "object": "payment_method",
      "code": "mollie:swish",
      "gateway": "mollie",
      "label": "Swish",
      "logo_url": null,
      "charge_currency": "SEK"
    }
  ]
}

Select a payment method

POST/api/v1/payments/{id}/method

Starts the payment at the provider for the method the buyer picked, and answers the payment with next_action: what your site shows or does next. Call it for a created payment, after the buyer chose a method from GET /v1/payment-methods. The method is the code of that list. Selecting is idempotent: the same method again returns the stored next_action without calling the provider again; another method on a payment that already has one is refused with 409 already_selected. A payment that needs billing details (an invoice) is refused with 409 billing_required: send the buyer to checkout_url for those. expected_provider_amount, when you send it, is the local-currency amount you quoted the buyer (in minor units); a different computed amount is 409 rate_changed.

next_action.type says what to show:

  • redirect: send the buyer to redirect_url, a https page of the provider.
  • crypto: show the QR code of uri, with coin, amount (in coin units, exactly as quoted), address and expires_at.
  • bank_transfer: show bank_name, iban, bic and reference. The buyer must quote reference exactly in the transfer, or the payment cannot be matched. redirect_url, when present, is the provider's instructions page.
  • none: test mode, nothing to show; the status moves by itself.

Do not take the buyer's word for it that they paid: confirm with the payment.paid webhook or GET /v1/payments/{id}, as with the hosted checkout.

Parameters
NameInTypeDescription
idrequiredpathstringThe payment id, pay_ followed by 24 characters.
Request body (SelectMethodBody), required
FieldTypeDescription
methodrequiredstring
expected_provider_amountstring
Responses
StatusBodyDescription
200PaymentWithNextActionThe payment, with next_action. For a repeat of the same method it is the stored next_action.
400ErrorThe request is not valid: malformed JSON (invalid_json), a field that fails validation (invalid_request, with the field in param), a value the payment rules refuse after that validation, such as the description, the return URL, the metadata or a list limit (invalid_input, the message says which rule), an amount that is not a decimal string (invalid_amount), a bad Idempotency-Key (invalid_idempotency_key) or a bad starting_after (invalid_cursor).
401ErrorThe API key is missing, malformed, unknown or revoked, or its account is suspended. The reason is deliberately not given.
404ErrorNo such payment in the mode of your API key. A payment that belongs to someone else, one of the other mode and an id of the wrong shape all look the same.
409ErrorThe payment cannot take this method now (409): another method was already chosen (already_selected), a start is in progress (selection_in_progress, retry after Retry-After), the payment is no longer selectable (not_selectable) or has expired (expired), the buyer country is not supported for the method (country_unsupported), the exchange rate moved since the quote in expected_provider_amount (rate_changed; read the payment again or retry without the quote), or the method needs billing details (billing_required): an invoiced payment takes its billing details only on the hosted checkout, so send the buyer to checkout_url. details_required means the buyer must give details first, also on the checkout. Nothing was started at the provider.
422ErrorThe method cannot be used for this payment (method_unavailable), or the amount is too small for the method (amount_too_small). The method may be listed for the amount and still refused for this payment (order lines, an invoice, a buyer country): list the methods again or offer another one.
429ErrorToo many requests: 120 per minute per API key, and a per-address limit in front of it.
502ErrorThe payment provider could not be reached while starting the payment (provider_error). Nothing was stored as selected: the claim was reverted, so the same request is safe to repeat after the time in Retry-After.
503ErrorThe method is not configured for your account (gateway_not_configured) right now. Nothing was started; retry after the time in Retry-After, or offer another method.
Requestcurl
curl -sS -X POST "https://payments.example.com/api/v1/payments/pay_0123456789abcdefghjkmnpq/method" \
  -H "Authorization: Bearer cp_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "method": "mollie:ideal"
  }'
Response 200JSON
{
  "id": "pay_0123456789abcdefghjkmnpq",
  "object": "payment",
  "status": "pending",
  "amount": "49.00",
  "currency": "EUR",
  "charge": {
    "amount": "49.00",
    "currency": "EUR",
    "fx_rate": "1",
    "fx_date": null,
    "net_amount": "49.00",
    "vat_amount": "0.00"
  },
  "provider_charge": null,
  "fee": "1.13",
  "description": "Order 42",
  "metadata": {
    "order_id": "42"
  },
  "checkout_url": "https://payments.example.com/pay/3vQB7B6MrGQHehYtG8JNQSjQdXbNUjpkLUWGDKvvQdk",
  "livemode": false,
  "method": "mollie:ideal",
  "created": "2026-11-06T12:00:00.000Z",
  "expires_at": "2026-11-07T12:00:00.000Z",
  "paid_at": null,
  "subscription_id": null,
  "next_action": {
    "type": "redirect",
    "redirect_url": "https://pay.example.com/ideal/0f3c9a"
  }
}

Subscriptions

List subscriptions

GET/api/v1/subscriptions

The subscriptions of the mode of your API key (a test key lists test subscriptions, a live key live ones), newest first.

Parameters
NameInTypeDescription
limitqueryintegerHow many subscriptions to return.
starting_afterquerystringThe id of the last subscription of the previous page. Returns the subscriptions created before it.
Responses
StatusBodyDescription
200SubscriptionListA page of subscriptions.
400ErrorThe request is not valid: malformed JSON (invalid_json), a field that fails validation (invalid_request, with the field in param), a value the payment rules refuse after that validation, such as the description, the return URL, the metadata or a list limit (invalid_input, the message says which rule), an amount that is not a decimal string (invalid_amount), a bad Idempotency-Key (invalid_idempotency_key) or a bad starting_after (invalid_cursor).
401ErrorThe API key is missing, malformed, unknown or revoked, or its account is suspended. The reason is deliberately not given.
429ErrorToo many requests: 120 per minute per API key, and a per-address limit in front of it.
500ErrorSomething went wrong on our side. Nothing was changed by a request with an Idempotency-Key, so it is safe to retry it.
Requestcurl
curl -sS "https://payments.example.com/api/v1/subscriptions" \
  -H "Authorization: Bearer cp_test_..."
Response 200JSON
{
  "object": "list",
  "data": [
    {
      "id": "sub_0123456789abcdefghjkmnpq",
      "object": "subscription",
      "status": "pending_mandate",
      "amount": "49.00",
      "currency": "EUR",
      "interval": "1 month",
      "times": 12,
      "description": "Plus plan, monthly",
      "metadata": {
        "plan": "plus"
      },
      "livemode": true,
      "first_payment_id": "pay_7777777777abcdefghjkmnpq",
      "next_charge_date": null,
      "created": "2026-11-18T10:00:00.000Z",
      "activated_at": null,
      "canceled_at": null
    },
    {
      "id": "sub_9876543210zyxwvtsrqpnmkh",
      "object": "subscription",
      "status": "active",
      "amount": "49.00",
      "currency": "EUR",
      "interval": "1 month",
      "times": 12,
      "description": "Plus plan, monthly",
      "metadata": {
        "plan": "plus"
      },
      "livemode": true,
      "first_payment_id": "pay_8888888888zyxwvtsrqpnmkh",
      "next_charge_date": "2026-12-18",
      "created": "2026-11-18T10:00:00.000Z",
      "activated_at": "2026-11-18T10:05:00.000Z",
      "canceled_at": null
    }
  ],
  "has_more": false
}

Create a subscription

POST/api/v1/subscriptions

Creates a subscription and its first payment, and returns both. The subscription is pending_mandate; first_payment is the payment the buyer pays now, on its checkout_url or with POST /v1/payments/{id}/method, as for any payment. When the first payment is paid, the subscription becomes active, and we charge the buyer every interval until times recurring charges have been made or the subscription is canceled. Each recurring charge is a payment of its own, with subscription_id set and the usual payment.* webhook events; the buyer does nothing for it. Send an Idempotency-Key to make a retry safe, as for POST /v1/payments: the same key with the same body returns the first response, and a different body with the same key is refused with 422. v1 limits. Live keys only: a test key is refused with 422 livemode_required. EUR only. Not for accounts whose payments are invoiced (422 invoicing_unsupported). The first payment may be paid only with a method that gives a recurring mandate. For a managed account (we take the payment) that is card, Apple Pay, Google Pay or PayPal, and those are offered only when the operator allows them; for a bring-your-own account also iDEAL, Bancontact, Belfius, EPS, KBC and Pay by Bank, which give a SEPA Direct Debit mandate. A managed account with no eligible method is refused with 422 no_methods.

Parameters
NameInTypeDescription
Idempotency-KeyheaderstringMakes a retry safe. 1 to 200 characters of letters, digits and _ . : -. Scoped to your account and mode; kept for 24 hours. A replay returns the stored first response as it was: a key stored before charge was added replays a payment without charge until it expires.
Request body (CreateSubscriptionBody), required
FieldTypeDescription
amountrequiredstringCharged every interval, in major units.
currencyrequired"EUR"
intervalrequiredstringTime between charges: <n> days, <n> weeks or <n> months, at most 365 days, 52 weeks or 12 months.
timesintegerHow many charges follow the first payment; leave it out to charge until canceled.
descriptionrequiredstring
return_urlrequiredstring (uri)
metadataobject
Responses
StatusBodyDescription
201SubscriptionWithFirstPaymentThe subscription, with its first_payment. For a replay it is the stored first response.
400ErrorThe request is not valid: malformed JSON (invalid_json), a field that fails validation (invalid_request, with the field in param), a value the payment rules refuse after that validation, such as the description, the return URL, the metadata or a list limit (invalid_input, the message says which rule), an amount that is not a decimal string (invalid_amount), a bad Idempotency-Key (invalid_idempotency_key) or a bad starting_after (invalid_cursor).
401ErrorThe API key is missing, malformed, unknown or revoked, or its account is suspended. The reason is deliberately not given.
403ErrorThe account cannot take payments: it is suspended, or its type does not support the API.
413ErrorThe request body is larger than 32 KB.
415ErrorThe Content-Type is not application/json.
422ErrorThe subscription cannot be created (422): no first-payment method is offered to your account for this amount (no_methods; see the operation for which methods), the account is in test mode (livemode_required), the account is invoiced (invoicing_unsupported), fees are not configured (no_fee_rule), the amount does not cover the fee or is too small (amount_too_small), or the Idempotency-Key was used with a different request (idempotency_key_reuse). Nothing was created.
429ErrorToo many requests: 120 per minute per API key, and a per-address limit in front of it.
500ErrorSomething went wrong on our side. Nothing was changed by a request with an Idempotency-Key, so it is safe to retry it.
Requestcurl
curl -sS -X POST "https://payments.example.com/api/v1/subscriptions" \
  -H "Authorization: Bearer cp_test_..." \
  -H "Idempotency-Key: order-42-attempt-1" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "49.00",
    "currency": "EUR",
    "interval": "1 month",
    "times": 12,
    "description": "Plus plan, monthly",
    "return_url": "https://shop.example.com/thanks",
    "metadata": {
      "plan": "plus"
    }
  }'
Response 201JSON
{
  "id": "sub_0123456789abcdefghjkmnpq",
  "object": "subscription",
  "status": "pending_mandate",
  "amount": "49.00",
  "currency": "EUR",
  "interval": "1 month",
  "times": 12,
  "description": "Plus plan, monthly",
  "metadata": {
    "plan": "plus"
  },
  "livemode": true,
  "first_payment_id": "pay_7777777777abcdefghjkmnpq",
  "next_charge_date": null,
  "created": "2026-11-18T10:00:00.000Z",
  "activated_at": null,
  "canceled_at": null,
  "first_payment": {
    "id": "pay_7777777777abcdefghjkmnpq",
    "object": "payment",
    "status": "created",
    "amount": "49.00",
    "currency": "EUR",
    "charge": {
      "amount": "49.00",
      "currency": "EUR",
      "fx_rate": "1",
      "fx_date": null,
      "net_amount": "49.00",
      "vat_amount": "0.00"
    },
    "provider_charge": null,
    "fee": "1.13",
    "description": "Plus plan, monthly",
    "metadata": {
      "plan": "plus"
    },
    "checkout_url": "https://payments.example.com/pay/Lm4Rt8ZkQw2VxYb6HnJcPdSaEfGiU0KoXtNq3BvM9yD",
    "livemode": false,
    "method": null,
    "created": "2026-11-18T10:00:00.000Z",
    "expires_at": "2026-11-19T10:00:00.000Z",
    "paid_at": null,
    "subscription_id": "sub_0123456789abcdefghjkmnpq"
  }
}

Retrieve a subscription

GET/api/v1/subscriptions/{id}

Parameters
NameInTypeDescription
idrequiredpathstringThe subscription id, sub_ followed by 24 characters.
Responses
StatusBodyDescription
200SubscriptionThe subscription.
401ErrorThe API key is missing, malformed, unknown or revoked, or its account is suspended. The reason is deliberately not given.
404ErrorNo such subscription in the mode of your API key. A subscription that belongs to someone else, one of the other mode and an id of the wrong shape all look the same.
429ErrorToo many requests: 120 per minute per API key, and a per-address limit in front of it.
500ErrorSomething went wrong on our side. Nothing was changed by a request with an Idempotency-Key, so it is safe to retry it.
Requestcurl
curl -sS "https://payments.example.com/api/v1/subscriptions/sub_0123456789abcdefghjkmnpq" \
  -H "Authorization: Bearer cp_test_..."
Response 200JSON
{
  "id": "sub_9876543210zyxwvtsrqpnmkh",
  "object": "subscription",
  "status": "active",
  "amount": "49.00",
  "currency": "EUR",
  "interval": "1 month",
  "times": 12,
  "description": "Plus plan, monthly",
  "metadata": {
    "plan": "plus"
  },
  "livemode": true,
  "first_payment_id": "pay_8888888888zyxwvtsrqpnmkh",
  "next_charge_date": "2026-12-18",
  "created": "2026-11-18T10:00:00.000Z",
  "activated_at": "2026-11-18T10:05:00.000Z",
  "canceled_at": null
}

Cancel a subscription

POST/api/v1/subscriptions/{id}/cancel

Stops the recurring charges. An active subscription is canceled at the provider first, so no further charge is made, and then becomes canceled. A pending_mandate subscription has its first payment canceled and becomes canceled; it never becomes active. A subscription in a final status (canceled, completed, abandoned) is refused with 409 not_cancellable. A 502 provider_error means the provider could not be reached: nothing changed locally, the subscription is still active, and the call is safe to repeat after the Retry-After seconds. The request takes no body.

Parameters
NameInTypeDescription
idrequiredpathstringThe subscription id, sub_ followed by 24 characters.
Responses
StatusBodyDescription
200SubscriptionThe subscription after the cancel: canceled.
401ErrorThe API key is missing, malformed, unknown or revoked, or its account is suspended. The reason is deliberately not given.
404ErrorNo such subscription in the mode of your API key. A subscription that belongs to someone else, one of the other mode and an id of the wrong shape all look the same.
409ErrorThe subscription cannot be canceled (not_cancellable): it is already in a final status (canceled, completed or abandoned). Nothing changed.
429ErrorToo many requests: 120 per minute per API key, and a per-address limit in front of it.
500ErrorSomething went wrong on our side. Nothing was changed by a request with an Idempotency-Key, so it is safe to retry it.
502ErrorThe payment provider could not be reached while canceling the subscription (provider_error). Nothing changed locally: the subscription is still active and the cancel is safe to repeat after the time in Retry-After.
Requestcurl
curl -sS -X POST "https://payments.example.com/api/v1/subscriptions/sub_0123456789abcdefghjkmnpq/cancel" \
  -H "Authorization: Bearer cp_test_..."
Response 200JSON
{
  "id": "sub_9876543210zyxwvtsrqpnmkh",
  "object": "subscription",
  "status": "canceled",
  "amount": "49.00",
  "currency": "EUR",
  "interval": "1 month",
  "times": 12,
  "description": "Plus plan, monthly",
  "metadata": {
    "plan": "plus"
  },
  "livemode": true,
  "first_payment_id": "pay_8888888888zyxwvtsrqpnmkh",
  "next_charge_date": null,
  "created": "2026-11-18T10:00:00.000Z",
  "activated_at": "2026-11-18T10:05:00.000Z",
  "canceled_at": "2026-11-20T09:00:00.000Z"
}

Objects

The request and response bodies above, field by field. A field marked required is always present in a response, and must be sent in a request.

CreatePaymentRequest

Fields of CreatePaymentRequest
FieldTypeDescription
amountrequiredstringThe price as a decimal string in major units, for example "49.00". At most 2 decimals.
currencyrequired"EUR" | "USD"The currency the payment is priced in. The buyer is charged in EUR (except BLIK, TWINT, Swish and Vipps, which charge the plain ECB amount in PLN, CHF, SEK or NOK: see provider_charge): a USD price is converted at the latest ECB euro reference rate, rounded half up to the cent.
descriptionrequiredstringWhat the payment is for. Shown to the buyer.
return_urlrequiredstring (uri)Where the buyer is sent after the checkout. An http(s) URL without credentials.
expires_in_minutesintegerHow many minutes the payment stays payable: a whole number from 1 to 1440. After that time the payment expires and can no longer be paid. Absent: 1440 (24 hours). A method with its own payment window (Multibanco, bank transfer, a cash voucher) moves the expiry to the pick time plus that window, as before.
metadataobjectYour own string key-value pairs, returned unchanged on the payment.
linesarray of objectThe order lines, for the pay-later methods. Their totals must add up to amount. Only for payments made with your own provider keys. Write-only: never returned.
lines[].descriptionrequiredstringWhat the line is. Shown to the buyer by the payment provider.
lines[].quantityrequiredintegerHow many units. A whole number, at least 1.
lines[].unit_pricerequiredstringThe price of one unit as a decimal string in the payment currency.
lines[].total_amountrequiredstringThe line total: unit_price times quantity minus discount_amount. The totals of all lines must add up to the payment amount.
lines[].discount_amountstringA discount on the whole line, as a decimal string.
lines[].vat_ratestringThe VAT rate in percent, for example "21.00", included in the line total.
lines[].skustringYour stock keeping unit for the line.
lines[].type"physical" | "digital" | "shipping_fee" | "discount" | "store_credit" | "gift_card" | "surcharge" | "tip"The kind of line.
lines[].categoriesarray of "eco" | "gift" | "meal" | "sport_culture" | "additional" | "consume"Voucher categories the line belongs to (meal and eco vouchers).
billing_addressobjectThe buyer billing address, for the pay-later methods. Only for payments made with your own provider keys. Write-only: never returned.
billing_address.given_namerequiredstringGiven name, 2 to 100 characters.
billing_address.family_namerequiredstringFamily name, 2 to 100 characters.
billing_address.organization_namestringCompany name, up to 200 characters.
billing_address.street_and_numberrequiredstringStreet and house number, 2 to 200 characters.
billing_address.street_additionalstringAdditional address line, up to 200 characters.
billing_address.postal_coderequiredstringPostal code, up to 20 characters.
billing_address.cityrequiredstringCity, up to 100 characters.
billing_address.regionstringRegion or state, up to 100 characters.
billing_address.countryrequiredstringISO 3166-1 alpha-2 country code, for example "PT".
billing_address.phonestringPhone number in international format, for example "+351912345678".
billing_address.emailrequiredstringThe buyer email address.
shipping_addressobjectThe delivery address; needs billing_address. Only for payments made with your own provider keys. Write-only: never returned.
shipping_address.given_namerequiredstringGiven name, 2 to 100 characters.
shipping_address.family_namerequiredstringFamily name, 2 to 100 characters.
shipping_address.organization_namestringCompany name, up to 200 characters.
shipping_address.street_and_numberrequiredstringStreet and house number, 2 to 200 characters.
shipping_address.street_additionalstringAdditional address line, up to 200 characters.
shipping_address.postal_coderequiredstringPostal code, up to 20 characters.
shipping_address.cityrequiredstringCity, up to 100 characters.
shipping_address.regionstringRegion or state, up to 100 characters.
shipping_address.countryrequiredstringISO 3166-1 alpha-2 country code, for example "PT".
shipping_address.phonestringPhone number in international format, for example "+351912345678".
shipping_address.emailstringThe recipient email address.

Payment

Fields of Payment
FieldTypeDescription
idrequiredstring
objectrequired"payment"
statusrequired"created" | "pending" | "paid" | "paid_late" | "failed" | "expired" | "canceled"created: waiting for the buyer. pending: the buyer chose a method. paid, failed, canceled and expired are final; paid_late is an expired payment that was paid anyway and needs a manual review.
amountrequiredstringThe price you asked for, as a decimal string in major units, in currency. What the buyer is actually charged is in charge.
currencyrequired"EUR" | "USD"The currency of amount: the one you priced the payment in.
chargerequiredobjectWhat the buyer is charged: the total they pay. A price in USD is converted to EUR at the latest ECB euro reference rate, rounded half up to the cent; a price in EUR is charged as it is, with rate "1".
charge.amountrequiredstringThe total the buyer pays, VAT included, as a decimal string in charge.currency. It is the amount the payment provider charges. For a payment that gets an invoice it equals net_amount until the buyer has given their billing details and confirmed the VAT, and net_amount plus vat_amount from then on.
charge.currencyrequired"EUR" | "USD"The currency the buyer is charged in: EUR for every managed payment; the price currency (EUR or USD) for a payment made with your own provider keys. Payments created before EUR charging may be USD.
charge.fx_raterequiredstringThe ECB euro reference rate the price was converted at, in units of the price currency per 1 EUR, as a decimal string. "1" when nothing was converted.
charge.fx_daterequiredstring or nullThe day of that rate (UTC), YYYY-MM-DD. Null when nothing was converted.
charge.net_amountrequiredstringThe price before VAT, as a decimal string in charge.currency: your price converted to EUR for a USD price, the same as amount for a EUR price. Your fee and your payout are computed on it.
charge.vat_amountrequiredstringThe VAT the buyer pays, as a decimal string in charge.currency. "0.00" when no VAT applies (a BTCPay payment, a buyer outside the EU, a business buyer in another EU country with a valid VAT number, a payment without an invoice) and until the buyer has confirmed their billing details.
provider_chargerequiredobject or nullWhat the gateway charges the buyer in a local currency (PLN, CHF, SEK or NOK), once the buyer has chosen a local-currency method (BLIK, TWINT, Swish or Vipps). Null until then, and for every other method. charge stays the total in EUR.
provider_charge.amountrequiredstringWhat the buyer is charged by the gateway, as a decimal string in provider_charge.currency: the total in EUR (charge.amount) times fx_rate, rounded half up to the minor unit. The buyer pays no margin on top: the margin is the FX fee you bear.
provider_charge.currencyrequired"PLN" | "CHF" | "SEK" | "NOK"The local currency the buyer is charged in.
provider_charge.fx_raterequiredstringThe ECB euro reference rate used, in units of provider_charge.currency per 1 EUR, as a decimal string.
provider_charge.fx_daterequiredstringThe day of that rate (UTC), YYYY-MM-DD.
provider_charge.margin_bpsrequiredintegerThe margin, in basis points, that the FX fee was computed with.
provider_charge.fx_feerequiredstringThe FX fee you bear for converting to the local currency, as a decimal string in the currency of charge. It is part of fee.
feerequiredstringOur fee on this payment, as a decimal string in the currency of charge: it is calculated on the amount charged. Once the buyer has chosen a local-currency method it includes provider_charge.fx_fee, so it can rise after the payment was created.
descriptionrequiredstring
metadatarequiredobject
checkout_urlrequiredstring (uri)The hosted checkout page. Send the buyer here.
livemoderequiredbooleanFalse for payments made with a test API key.
methodrequiredstring or nullThe payment method the buyer chose, or null before that.
createdrequiredstring (date-time)
expires_atrequiredstring (date-time)After this time an unpaid payment expires. It is set when the payment is created (24 hours later, or expires_in_minutes later when you sent one) and moves once, later, when the buyer picks a method that has its own payment window (Multibanco or bank transfer, for example); read it again after the buyer has chosen.
paid_atrequiredstring (date-time) or null
subscription_idrequiredstring or nullThe subscription this payment belongs to (its first payment or one of its charges), or null for a one-off payment.

PaymentList

Fields of PaymentList
FieldTypeDescription
objectrequired"list"
datarequiredarray of Payment
has_morerequiredbooleanWhether more payments follow; pass the last id as starting_after.

Error

Fields of Error
FieldTypeDescription
errorrequiredobject
error.coderequiredstringA stable machine-readable code.
error.messagerequiredstringA fixed, human-readable explanation. It never repeats what you sent.
error.paramstringThe request field the error is about.

PaymentMethod

Fields of PaymentMethod
FieldTypeDescription
objectrequired"payment_method"
coderequiredstringWhat to send as method when starting the payment. <gateway>:<method>.
gatewayrequiredstringThe provider the method runs on; use it to group methods.
labelrequiredstringThe name to show the buyer.
logo_urlrequiredstring (uri) or nullAn absolute URL of the method logo served by us, or null when there is none.
charge_currencyrequired"PLN" | "CHF" | "SEK" | "NOK" or nullThe local currency the buyer is charged in for this method (BLIK, TWINT, Swish, Vipps), else null.

PaymentMethodList

Fields of PaymentMethodList
FieldTypeDescription
objectrequired"list"
datarequiredarray of PaymentMethod

NextAction

NextAction, type: "redirect"
FieldTypeDescription
typerequired"redirect"
redirect_urlrequiredstring (uri)Send the buyer to this https page of the provider.
NextAction, type: "crypto"
FieldTypeDescription
typerequired"crypto"
coinrequiredstring
amountrequiredstringIn the coin units, exactly as quoted.
addressrequiredstring
urirequiredstringWhat a QR code should encode.
expires_atrequiredstring (date-time)
NextAction, type: "bank_transfer"
FieldTypeDescription
typerequired"bank_transfer"
bank_namerequiredstring
ibanrequiredstring
bicrequiredstring
referencerequiredstringThe buyer must quote this exactly in the transfer.
redirect_urlrequiredstring (uri) or nullThe provider's own instructions page, when there is one.
NextAction, type: "none"
FieldTypeDescription
typerequired"none"

PaymentWithNextAction

Fields of PaymentWithNextAction
FieldTypeDescription
idrequiredstring
objectrequired"payment"
statusrequired"created" | "pending" | "paid" | "paid_late" | "failed" | "expired" | "canceled"created: waiting for the buyer. pending: the buyer chose a method. paid, failed, canceled and expired are final; paid_late is an expired payment that was paid anyway and needs a manual review.
amountrequiredstringThe price you asked for, as a decimal string in major units, in currency. What the buyer is actually charged is in charge.
currencyrequired"EUR" | "USD"The currency of amount: the one you priced the payment in.
chargerequiredobjectWhat the buyer is charged: the total they pay. A price in USD is converted to EUR at the latest ECB euro reference rate, rounded half up to the cent; a price in EUR is charged as it is, with rate "1".
charge.amountrequiredstringThe total the buyer pays, VAT included, as a decimal string in charge.currency. It is the amount the payment provider charges. For a payment that gets an invoice it equals net_amount until the buyer has given their billing details and confirmed the VAT, and net_amount plus vat_amount from then on.
charge.currencyrequired"EUR" | "USD"The currency the buyer is charged in: EUR for every managed payment; the price currency (EUR or USD) for a payment made with your own provider keys. Payments created before EUR charging may be USD.
charge.fx_raterequiredstringThe ECB euro reference rate the price was converted at, in units of the price currency per 1 EUR, as a decimal string. "1" when nothing was converted.
charge.fx_daterequiredstring or nullThe day of that rate (UTC), YYYY-MM-DD. Null when nothing was converted.
charge.net_amountrequiredstringThe price before VAT, as a decimal string in charge.currency: your price converted to EUR for a USD price, the same as amount for a EUR price. Your fee and your payout are computed on it.
charge.vat_amountrequiredstringThe VAT the buyer pays, as a decimal string in charge.currency. "0.00" when no VAT applies (a BTCPay payment, a buyer outside the EU, a business buyer in another EU country with a valid VAT number, a payment without an invoice) and until the buyer has confirmed their billing details.
provider_chargerequiredobject or nullWhat the gateway charges the buyer in a local currency (PLN, CHF, SEK or NOK), once the buyer has chosen a local-currency method (BLIK, TWINT, Swish or Vipps). Null until then, and for every other method. charge stays the total in EUR.
provider_charge.amountrequiredstringWhat the buyer is charged by the gateway, as a decimal string in provider_charge.currency: the total in EUR (charge.amount) times fx_rate, rounded half up to the minor unit. The buyer pays no margin on top: the margin is the FX fee you bear.
provider_charge.currencyrequired"PLN" | "CHF" | "SEK" | "NOK"The local currency the buyer is charged in.
provider_charge.fx_raterequiredstringThe ECB euro reference rate used, in units of provider_charge.currency per 1 EUR, as a decimal string.
provider_charge.fx_daterequiredstringThe day of that rate (UTC), YYYY-MM-DD.
provider_charge.margin_bpsrequiredintegerThe margin, in basis points, that the FX fee was computed with.
provider_charge.fx_feerequiredstringThe FX fee you bear for converting to the local currency, as a decimal string in the currency of charge. It is part of fee.
feerequiredstringOur fee on this payment, as a decimal string in the currency of charge: it is calculated on the amount charged. Once the buyer has chosen a local-currency method it includes provider_charge.fx_fee, so it can rise after the payment was created.
descriptionrequiredstring
metadatarequiredobject
checkout_urlrequiredstring (uri)The hosted checkout page. Send the buyer here.
livemoderequiredbooleanFalse for payments made with a test API key.
methodrequiredstring or nullThe payment method the buyer chose, or null before that.
createdrequiredstring (date-time)
expires_atrequiredstring (date-time)After this time an unpaid payment expires. It is set when the payment is created (24 hours later, or expires_in_minutes later when you sent one) and moves once, later, when the buyer picks a method that has its own payment window (Multibanco or bank transfer, for example); read it again after the buyer has chosen.
paid_atrequiredstring (date-time) or null
subscription_idrequiredstring or nullThe subscription this payment belongs to (its first payment or one of its charges), or null for a one-off payment.
next_actionrequiredNextAction

SelectMethodBody

Fields of SelectMethodBody
FieldTypeDescription
methodrequiredstring
expected_provider_amountstring

CreateSubscriptionBody

Fields of CreateSubscriptionBody
FieldTypeDescription
amountrequiredstringCharged every interval, in major units.
currencyrequired"EUR"
intervalrequiredstringTime between charges: <n> days, <n> weeks or <n> months, at most 365 days, 52 weeks or 12 months.
timesintegerHow many charges follow the first payment; leave it out to charge until canceled.
descriptionrequiredstring
return_urlrequiredstring (uri)
metadataobject

Subscription

Fields of Subscription
FieldTypeDescription
idrequiredstring
objectrequired"subscription"
statusrequired"pending_mandate" | "active" | "canceled" | "completed" | "abandoned"pending_mandate: waiting for the buyer to pay the first payment. active: charged every interval. canceled (by you, by canceling the first payment, or at the provider), completed (all times charged) and abandoned (the first payment failed or expired, or was paid after its window) are final.
amountrequiredstring
currencyrequired"EUR"
intervalrequiredstring
timesrequiredinteger or null
descriptionrequiredstring
metadatarequiredobject
livemoderequiredboolean
first_payment_idrequiredstringThe payment that gives the mandate; the buyer pays it like any payment.
next_charge_daterequiredstring or nullThe day (YYYY-MM-DD) of the next charge, once active.
createdrequiredstring (date-time)
activated_atrequiredstring (date-time) or null
canceled_atrequiredstring (date-time) or null

SubscriptionWithFirstPayment

Fields of SubscriptionWithFirstPayment
FieldTypeDescription
idrequiredstring
objectrequired"subscription"
statusrequired"pending_mandate" | "active" | "canceled" | "completed" | "abandoned"pending_mandate: waiting for the buyer to pay the first payment. active: charged every interval. canceled (by you, by canceling the first payment, or at the provider), completed (all times charged) and abandoned (the first payment failed or expired, or was paid after its window) are final.
amountrequiredstring
currencyrequired"EUR"
intervalrequiredstring
timesrequiredinteger or null
descriptionrequiredstring
metadatarequiredobject
livemoderequiredboolean
first_payment_idrequiredstringThe payment that gives the mandate; the buyer pays it like any payment.
next_charge_daterequiredstring or nullThe day (YYYY-MM-DD) of the next charge, once active.
createdrequiredstring (date-time)
activated_atrequiredstring (date-time) or null
canceled_atrequiredstring (date-time) or null
first_paymentrequiredPayment

SubscriptionList

Fields of SubscriptionList
FieldTypeDescription
objectrequired"list"
datarequiredarray of Subscription
has_morerequiredboolean