Create Custom Charge
Subscription Charge
Create Custom Charge
This endpoint processes an off-cycle or custom charge for an active subscription.
Notes:
- By default,
countsAsCycleis false.- When
countsAsCycleis false, the subscription’s billing cycle remains unchanged.- Set
countsAsCycleto true if the custom charge should be treated as a scheduled billing cycle.
POST
Create Custom Charge
Authorizations
Payaza {{Public API Key in Base 64}}
Path Parameters
The Plan ID.
Body
application/json
The amount to be charged.
Example:
1500
The 3-letter ISO currency code.
Example:
"NGN"
A brief description or reason for the one-off charge.
Example:
"Additional Storage"
A Unique identifier used to prevent duplicate charge requests.
Example:
"OFFCYCLE-001"
Indicates whether this charge should count as a normal subscription billing cycle. Defaults to false.
Example:
false