Get Usage Charge List

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

Retrieve all usage charges associated with a specific recurring application charge.

Request

Path Parameters

recurring_charge_id stringrequired

Query Parameters

per_page int32required

Limit per page

since_id string

The query results are in reverse order, and this parameter limits the results after the specified ID.

Responses

200

200

application/json

Schema

Schema

usage_charges object[]
Array [
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

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

Result

{
    "usage_charges": [
        {
            "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"
  ]
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

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

Result

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