Unique identifier of the recurring application charge.
recurring_application_charge. name
string
"test"
Name of the recurring application charge.
recurring_application_charge. price
string
"100"
The recurring charge price.
recurring_application_charge. activated_on
string
"2024-04-23T00:00:00Z"
Activation date of the recurring application charge in ISO 8601 format.
recurring_application_charge. billing_on
string
"2024-05-23T00:00:00Z"
The next billing date of the recurring application charge in ISO 8601 format.
recurring_application_charge. cancelled_on
string
null
Cancellation date of the recurring application charge, if applicable.
recurring_application_charge. capped_amount
string
"10"
The terms and conditions of usage based billing charges. Must be present in order to create usage charges, for example when the capped_amount property is provided. Presented to the merchant when they approve an app's usage charges.
recurring_application_charge. return_url
string
"
Redirect URL after payment.
recurring_application_charge. status
string
"active"
Current status of the recurring application charge.
recurring_application_charge. terms
string
"terms"
The terms and conditions of usage based billing charges. Must be present in order to create usage charges, for example when the capped_amount property is provided. Presented to the merchant when they approve an app's usage charges.
recurring_application_charge. test
boolean
false
Indicates whether this is a test charge.
recurring_application_charge. trial_days
integer
0
Trial period in days for the recurring application charge.
recurring_application_charge. trial_ends_on
string
null
End date of the trial period in ISO 8601 format, if applicable.
Creation timestamp of the recurring application charge in ISO 8601 format.
recurring_application_charge. updated_at
string
"2024-04-23T06:40:51Z"
Last update timestamp of the recurring application charge in ISO 8601 format.
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "Record not found"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
String
"page not found"
Indicates an error encountered during the process
Error Detail
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
404
Not Found
The recurring_charge_idi s not found.
"Record not found"
422
Unprocessable Entity
The recurring_charge_idis is empty.
"RecurringChargeId is required"
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
