The Get Recurring Application Charge API is used to retrieve detailed information about a specific recurring application charge using its unique identifier (charge_id). This API helps developers verify the status, configuration, and metadata of a recurring charge associated with an application.

This API is especially useful for:

Tracking the current status of a recurring charge (e.g., pending, active, cancelled).
Viewing important charge metadata such as price, terms, and return_url.
Auditing the lifecycle of a recurring application charge.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Description	Example
`charge_id`	string	required	The unique identifier of the recurring charge	`37222669345671159`

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_charge`	object	`{...}`	recurring charge

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