POST /usages

Creates a usage report.

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	ID of the usage record.
`_links[]`	Array	No	Related links.
`_links[].href`	String	No	Link URL.
`_links[].rel`	String	No	Type of link. Valid values: `"self"`
`acceptPartialQuantity`	Boolean	No	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 value: false
`invoiceItemId`	String	No	ID of the invoice item to which usage is applied. This value is populated when the invoice is issued.
`updatedTime`	String	No	Date and time when the resource is updated. This value is set automatically when the resource is updated.
`createdTime`	String	No	Date and time when the resource is created. This value is set automatically when the resource is created.
`usageTime`	String	No	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.
`quantity`	Number	Yes	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.
`subscriptionId`	String	Yes	Subscription ID for which the usage is reported.
`invoiceId`	String	No	ID of the invoice to which usage is applied. This value is populated when the invoice is issued.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.