POST /invoices/{id}/items
Creates an invoice item.
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 |
|---|---|---|---|
price |
Number | No |
Total price of the invoice item. |
tax |
Object | No |
Invoice item tax. |
_embedded |
Object | No |
Embedded objects that are requested by the |
_embedded.product |
Object | No | |
_embedded.plan |
Object | No | |
description |
String | No |
Description of the invoice item. |
createdTime |
String | No |
Date and time when the resource is created. This value is set automatically when the resource is created. |
planId |
String | No |
ID of the plan. |
quantity |
Integer | No |
Quantity of the invoice item. |
subscriptionId |
String | No |
ID of the order. |
id |
String | No |
ID of the invoice item. |
_links[] |
Array | No |
Related links. |
_links[].href |
String | No |
Link URL. |
_links[].rel |
String | No |
Type of link. Valid values:
|
productId |
String | No |
ID of the product. |
periodEndTime |
String | No |
Date and time when the billing period ends. |
updatedTime |
String | No |
Date and time when the resource is updated. This value is set automatically when the resource is updated. |
periodStartTime |
String | No |
Date and time when the billing period starts. |
periodNumber |
Integer | No |
Billing period number that is associated with the invoice item. For example, an invoice item for a service is included in billing period number 3. The invoice item is only applied to billing period number 3. |
type |
String | Yes |
Type of invoice item. Valid values:
|
discountAmount |
Number | No |
Discount amount applied to the invoice item. |
unitPrice |
Number | Yes |
Unit price of the invoice item. |
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.