Create Recurring Aplication Charge

POST 
/openapi/2022-01/recurring_application_charges

Create a recurring charge for an application.

Request

application/json

Body

Body

recurring_application_charge object

namestringrequired

The recurring application charge name.

pricefloatrequired

The price of the recurring application charge.

return_urlstringrequired

Redirect URL after payment

trial_daysint32

Trial period in days

capped_amountstring

The limit a customer can be charged for usage based billing. If this property is provided, then you must also provide the terms property. See usage charges for more information.

termsstring

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.

testboolean

Whether it is a test charge

Example

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

Responses

200

200

application/json

Schema

Schema

idstring
Example: 372269669345671159
application_idstring
Example: s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0
namestring
Example: test
pricestring
Example: 100
capped_amountstring
Example: 10
termsstring
Example: terms
return_urlstring
Example: https://shoplazza.com
confirmation_urlstring
Example: https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0/372269669345671159/recurring/confirm?signature=25e6433350d9dbb320bee53dd65b76db
statusstring
Example: pending
trial_daysinteger
Default value: 0
Example: 0
activated_on
trial_ends_on
billing_on
cancelled_on
cancel_sub_on
testboolean
Default value: true
Example: false
created_atstring
Example: 2024-04-23T06:26:45Z
updated_atstring
Example: 2024-04-23T06:26:45Z

Example

{
  "id": "372269669345671159",
  "application_id": "s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0",
  "name": "test",
  "price": "100",
  "capped_amount": "10",
  "terms": "terms",
  "return_url": "https://shoplazza.com",
  "confirmation_url": "https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0/372269669345671159/recurring/confirm?signature=25e6433350d9dbb320bee53dd65b76db",
  "status": "pending",
  "trial_days": 0,
  "activated_on": {},
  "trial_ends_on": {},
  "billing_on": {},
  "cancelled_on": {},
  "cancel_sub_on": {},
  "test": false,
  "created_at": "2024-04-23T06:26:45Z",
  "updated_at": "2024-04-23T06:26:45Z"
}

Result

{
    "id": "372269669345671159",
    "application_id": "s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0",
    "name": "test",
    "price": "100",
    "capped_amount": "10",
    "terms": "terms",
    "return_url": "https://shoplazza.com",
    "confirmation_url": "https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0/372269669345671159/recurring/confirm?signature=25e6433350d9dbb320bee53dd65b76db",
    "status": "pending",
    "trial_days": 0,
    "activated_on": null,
    "trial_ends_on": null,
    "billing_on": null,
    "cancelled_on": null,
    "cancel_sub_on": null,
    "test": false,
    "created_at": "2024-04-23T06:26:45Z",
    "updated_at": "2024-04-23T06:26:45Z"
}

422

422

application/json

No schema