Create recurring application charge

POST 
/openapi/2025-06/recurring_application_charges

Create a recurring charge for an application.

Request

application/json

Body

Bodyrequired

recurring_application_charge objectrequired

Recurring application charge

namestringrequired

The name of recurring application charge

pricefloatrequired

The price of the recurring application charge. Must match the package price defined in the app

return_urlstringrequired

The URL to redirect the merchant to after completing the subscription

trial_daysint32

The number of trial days offered for the subscription

capped_amountstring

Capped amount the merchant can be billed for usage-based charges. If this field is provided, terms must also be provided

termsstring

Terms and conditions for usage-based billing. Required if capped_amount is provided

testboolean

Whether to test the charge (default false)

charge_interval_daysint32

Charge interval in days. Defaults to 30, range 1-365

Example

{
  "recurring_application_charge": {
    "name": "string",
    "price": 0,
    "return_url": "string",
    "trial_days": 0,
    "capped_amount": "string",
    "terms": "string",
    "test": true,
    "charge_interval_days": 0
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

recurring_application_charge object

Recurring application charge

idstring

Recurring application charge ID

application_idstring

Application ID

namestring

Charge name shown to the merchant

pricestring

Recurring charge amount

capped_amountstring

Capped amount for usage-based billing

termsstring

Terms and conditions text shown to the merchant for usage-based billing

return_urlstring

URL the merchant returns to after confirming the charge

confirmation_urlstring

URL the merchant is redirected to in order to confirm the charge

statusstring

Current status of the recurring application charge

trial_daysint32

Number of trial days offered for the subscription

activated_onstring

Date when the subscription was activated

trial_ends_onstring

Date when the trial period ends

billing_onstring

Next billing date

cancelled_onstring

Charge cancellation date

cancel_sub_onstring

Subscription cancellation date

testboolean

Whether this is a test charge

created_atstring

Creation time, in ISO-8601 format

updated_atstring

Last update time, in ISO-8601 format

charge_interval_daysint32

Charge interval in days

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "recurring_application_charge": {
      "id": "string",
      "application_id": "string",
      "name": "string",
      "price": "string",
      "capped_amount": "string",
      "terms": "string",
      "return_url": "string",
      "confirmation_url": "string",
      "status": "string",
      "trial_days": 0,
      "activated_on": "string",
      "trial_ends_on": "string",
      "billing_on": "string",
      "cancelled_on": "string",
      "cancel_sub_on": "string",
      "test": true,
      "created_at": "string",
      "updated_at": "string",
      "charge_interval_days": 0
    }
  }
}