Create Recurring Application Charge

The Create Recurring Application Charge API is used to create a recurring charge for an application. This API is essential for developers implementing subscription-based billing workflows for their apps, allowing businesses to manage recurring charges with specific terms and limits.

This API is especially useful for:

Setting up recurring billing for application usage.
Defining usage-based billing terms and limits.
Managing application subscription charges with trial periods and specific conditions.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Body Parameters

Parameter	Type	Required	Description	Example
`recurring_application_charge.name`	string	Yes	Name of the recurring charge	`Premium Plan`
`recurring_application_charge.price`	float	Yes	Price of the charge (must be positive number)	`19.99`
`recurring_application_charge.return_url`	string	Yes	URL to redirect after charge confirmation	`https://example.com/return`
`recurring_application_charge.trial_days`	int32	No	Number of trial days (0 for no trial)	`14`
`recurring_application_charge.capped_amount`	string	No	Maximum amount that can be charged (if applicable)	`100.00`
`recurring_application_charge.terms`	string	No	Terms of the recurring charge	`Monthly subscription`
`recurring_application_charge.test`	boolean	No	Whether this is a test charge (default: false)	`true`

Response Description

Public Response Fields

📘
Public Response Parameters

Success Response

Field	Type	Example	Description
`code`	`string`	`"success"`	Status code of the response
`message`	`string`		Descriptive message of the response
`data.recurring_application_charges`	array of objects	`[ {...}, {...} ]`	List of recurring charges
`data.cursor`	string	`next_page_cursor`	Cursor for next page
`data.has_more`	boolean	`true`	Whether there are more pages available

Recurring Charge Object Structure

Parameter	Type	Example	Description
`id`	string	`rch_123456`	Unique identifier for the recurring charge
`application_id`	string	`app_123456`	ID of the associated application
`name`	string	`Premium Plan`	Name of the recurring charge
`price`	string	`19.99`	Price of the charge
`capped_amount`	string	`100.00`	Maximum amount that can be charged
`terms`	string	`Monthly subscription`	Terms of the charge
`return_url`	string	`https://example.com/return`	URL to return after confirmation
`confirmation_url`	string	`https://example.com/confirm`	URL to confirm the charge
`status`	string	`active`	Status of the charge
`trial_days`	int32	`14`	Number of trial days
`activated_on`	string	`2023-06-01T00:00:00Z`	Date when charge was activated (ISO 8601 format)
`trial_ends_on`	string	`2023-06-15T00:00:00Z`	Date when trial ends (ISO 8601 format)
`billing_on`	string	`2023-06-16T00:00:00Z`	Date when billing occurs (ISO 8601 format)
`cancelled_on`	string	`2023-06-30T00:00:00Z`	Date when charge was cancelled (ISO 8601 format)
`cancel_sub_on`	string	`2023-06-30T00:00:00Z`	Date when subscription was cancelled (ISO 8601 format)
`test`	boolean	`false`	Whether this is a test charge
`created_at`	string	`2023-05-01T00:00:00Z`	Creation time (ISO 8601 format)
`updated_at`	string	`2023-06-01T00:00:00Z`	Last modified time (ISO 8601 format)

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message