/
Create a usage record

Create a usage record

Request

Creates a usage report.

Security
SecretApiKey or JWT
Bodyapplication/jsonrequired
subscriptionIdstring, <= 50 charactersrequired

Subscription ID for which the usage is reported.

Example:"sub_01HRF27SATGE4Z6PBJE6PD8328"
quantitynumber, (double), >= 0.001required

Quantity of consumed units for a subscription plan product. Represents the actual usage of a billable product or service by the customer. Accepts both integer and decimal values with a precision of up to 3 decimal places. The minimum billable unit is 0.001.

Example:5.125
usageTimestring, (date-time)

Date and time, in ISO 8601 format, when a usage occurred. If this value is not provided or is empty, the date and time of the request is used.

acceptPartialQuantitybooleanwrite-only

Specifies whether partial usage should be accepted if the reported quantity exceeds the available limit.

When set to true, the system automatically adjusts the reported quantity to the maximum allowed limit and reports the usage. When set to false, the system rejects the request if the reported quantity exceeds the limit.

Default:false
Example:true
curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/usages \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "subscriptionId": "sub_01HRF27SATGE4Z6PBJE6PD8328",
    "quantity": 5.125,
    "usageTime": "2019-08-24T14:15:22Z",
    "acceptPartialQuantity": true
  }'

Responses

Usage record created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the usage record.

Example:"sub_usg_0YVJ636B95DNA9M3B1638HXBCQ"
subscriptionIdstring, <= 50 charactersrequired

Subscription ID for which the usage is reported.

Example:"sub_01HRF27SATGE4Z6PBJE6PD8328"
invoiceIdstring or null, <= 50 charactersread-only

ID of the invoice to which usage is applied. This value is populated when the invoice is issued.

Example:"in_0YVF9605RKC62BP14NE2R7V2XT"
invoiceItemIdstring or null, <= 50 charactersread-only

ID of the invoice item to which usage is applied. This value is populated when the invoice is issued.

Example:"ii_0YVFDEQS2KCFTBN9HXWJFY55GV"
quantitynumber, (double), >= 0.001required

Quantity of consumed units for a subscription plan product. Represents the actual usage of a billable product or service by the customer. Accepts both integer and decimal values with a precision of up to 3 decimal places. The minimum billable unit is 0.001.

Example:5.125
usageTimestring, (date-time)

Date and time, in ISO 8601 format, when a usage occurred. If this value is not provided or is empty, the date and time of the request is used.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
{
  "id": "sub_usg_0YVJ636B95DNA9M3B1638HXBCQ",
  "subscriptionId": "sub_01HRF27SATGE4Z6PBJE6PD8328",
  "invoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT",
  "invoiceItemId": "ii_0YVFDEQS2KCFTBN9HXWJFY55GV",
  "quantity": 5.125,
  "usageTime": "2019-08-24T14:15:22Z",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}