Create a one-time charge for a subscription
POST {{baseUrl}}/subscriptions/:subscription_id/charge
Creates a new one-time charge for a subscription. Use to bill non-recurring items to a subscription. Non-recurring items are price entities where the billing_cycle
is null
.
If successful, Paddle responds with the updated subscription entity. However, one-time charges aren't held against the subscription entity, so the charges billed aren't returned in the response.
Once created, to get details of a one-time charge:
- When created with
effective_from
asnext_billing_period
, get the subscription the charge was billed to and use theinclude
query parameter with thenext_transaction
value. - When created with
effective_from
asimmediately
, list transactions and use thesubscription_id
query parameter with the subscription ID of the subscription the charge was billed to.
When an update results in an immediate charge, responses may take longer than usual while a payment attempt is processed.
Request Body
{"effective_from"=>"<string>", "items"=>[{"quantity"=>"<integer>", "price_id"=>"<string>"}, {"quantity"=>"<integer>", "price_id"=>"<string>"}], "on_payment_failure"=>"prevent_change"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |