Create Usage Charge

POST 
/openapi/2022-01/recurring_application_charges/:recurring_charge_id/usage_charge

Create usage-based charges for a recurring application charge within Shoplazza.

Request

Path Parameters

recurring_charge_id stringrequired

application/json

Body

Body

usage_charge object

descriptionstringrequired

The description of the usage charge.

pricestringrequired

Usage fee price

Example

{
  "usage_charge": {
    "description": "string",
    "price": "string"
  }
}

Responses

200

200

application/json

Schema

Schema

balance_remainingstring
Example: 7.00
balance_usedstring
Example: 3.00
created_atstring
Example: 2024-04-23T06:53:17Z
descriptionstring
Example: Desc
idstring
Example: 372276344521766903
pricestring
Example: 3.00

Example

{
  "balance_remaining": "7.00",
  "balance_used": "3.00",
  "created_at": "2024-04-23T06:53:17Z",
  "description": "Desc",
  "id": "372276344521766903",
  "price": "3.00"
}

Result

{
    "balance_remaining": "7.00",
    "balance_used": "3.00",
    "created_at": "2024-04-23T06:53:17Z",
    "description": "Desc",
    "id": "372276344521766903",
    "price": "3.00"
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

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

Result

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