Update The Capped Amount Of Recurring Application Charge

PUT 
/openapi/2022-01/recurring_application_charges/:recurring_charge_id/customize

Update the capped amount for a recurring application charge.

Request

Path Parameters

recurring_charge_id stringrequired

application/json

Body

Body

capped_amountfloatrequired

The maximum usage fee must be greater than the original maximum

Example

{
  "capped_amount": 0
}

Responses

200

200

application/json

Schema

Schema

recurring_application_charge object
idstring
Example: 372269669345671159
namestring
Example: test
pricestring
Example: 100
activated_onstring
Example: 2024-04-23T00:00:00Z
billing_onstring
Example: 2024-05-23T00:00:00Z
cancelled_on
capped_amountstring
Example: 10
return_urlstring
Example: https://shoplazza.com
statusstring
Example: active
termsstring
Example: terms
testboolean
Default value: true
Example: false
trial_daysinteger
Default value: 0
Example: 0
trial_ends_on
update_capped_amount_urlstring
Example: https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0/372269669345671159/recurring_usage_charge/confirm?signature=1543b02176c185b4bfe70303b7f2b300&adjust_id=372273239407212535
created_atstring
Example: 2024-04-23T06:26:46Z
updated_atstring
Example: 2024-04-23T06:40:51Z

Example

{
  "recurring_application_charge": {
    "id": "372269669345671159",
    "name": "test",
    "price": "100",
    "activated_on": "2024-04-23T00:00:00Z",
    "billing_on": "2024-05-23T00:00:00Z",
    "cancelled_on": {},
    "capped_amount": "10",
    "return_url": "https://shoplazza.com",
    "status": "active",
    "terms": "terms",
    "test": false,
    "trial_days": 0,
    "trial_ends_on": {},
    "update_capped_amount_url": "https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0/372269669345671159/recurring_usage_charge/confirm?signature=1543b02176c185b4bfe70303b7f2b300&adjust_id=372273239407212535",
    "created_at": "2024-04-23T06:26:46Z",
    "updated_at": "2024-04-23T06:40:51Z"
  }
}

Result

{
    "recurring_application_charge": {
        "id": "372269669345671159",
        "name": "test",
        "price": "100",
        "activated_on": "2024-04-23T00:00:00Z",
        "billing_on": "2024-05-23T00:00:00Z",
        "cancelled_on": null,
        "capped_amount": "10",
        "return_url": "https://shoplazza.com",
        "status": "active",
        "terms": "terms",
        "test": false,
        "trial_days": 0,
        "trial_ends_on": null,
        "update_capped_amount_url": "https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0/372269669345671159/recurring_usage_charge/confirm?signature=1543b02176c185b4bfe70303b7f2b300&adjust_id=372273239407212535",
        "created_at": "2024-04-23T06:26:46Z",
        "updated_at": "2024-04-23T06:40:51Z"
    }
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Record not found"
  ]
}

Result

{
  "errors": [
    "Record not found"
  ]
}

422

422

text/plain

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "RecurringChargeId is required"
  ]
}

Result

{
  "errors": [
    "RecurringChargeId is required"
  ]
}