Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26336777.7 KB

Charge a one-time amount against an existing subscription using its saved payment method.

post/subscription/merchant/one-time-charge

Headers

Idempotency-Keystring

A unique key for making the request idempotent. Must match pattern: ^[a-zA-Z0-9\-_:\.]+$. See Idempotent Requests for more details.

Request body

subscriptionIdstring required

Unique identifier of the subscription to charge against. The subscription's saved payment method will be used for this charge.

amountinteger required

The amount in lowest count unit. e.g.: For USD 1, amount is 100 representing 100 cents. Must be within the currency's supported minimum and maximum bounds.

currencystring required

Three letter abbreviation of the currency. Refer supported currencies

commentsstring

Optional free-form note describing the reason for this one-time charge.

Example request

{
  "subscriptionId": "sub_fooBOwYsaK50AEfK",
  "amount": 500,
  "currency": "USD",
  "comments": "One-time setup fee for premium add-on"
}

Response

Subscription One Time Charge response

intentIdstring

Unique identifier of the payment intent created for this one-time charge.

statusstring

The status of the payment intent. Refer payment intent status

errorCodestring nullable

Machine readable failure reason when status is FAILED. null on a successful charge. See all possible values here.

errorMessagestring nullable

Human readable description of the failure reason when the charge was not successful. null on a successful charge.

Example response

{
  "intentId": "in_gKAqR0DjLeOihdTE",
  "status": "SUCCESS",
  "errorCode": "card_declined",
  "errorMessage": "The payment has been declined by the customer's bank."
}