/
Issue an upcoming invoice...

Issue an upcoming invoice for early pay

Request

Issues an upcoming invoice, for a subscription order with a specified ID, for early pay.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

Bodyapplication/jsonrequired

InvoiceIssue resource.

issuedTimestring or null, (date-time)

Date and time when the invoice is issued. If this field is null or omitted, the invoice is issued immediately.

dueTimestring or null, (date-time)

Date and time when the invoice is due for payment. If this field is null or omitted, this value is set to the issuedTime value.

curl -i -X POST \
  'https://www.rebilly.com/_mock/catalog/all/subscriptions/{id}/upcoming-invoice/issue' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "issuedTime": "2019-08-24T14:15:22Z",
    "dueTime": "2019-08-24T14:15:22Z"
  }'

Responses

Upcoming invoice issued.

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 upcoming invoice, which is persisted in the future renewal invoice.

Example:"in_0YVF9605RKC62BP14NE2R7V2XT"
websiteIdstring, <= 50 characters(WebsiteId)

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
subscriptionIdstring, <= 50 charactersread-only

ID of the related subscription order.

Example:"sub_01HRF27SATGE4Z6PBJE6PD8328"
currencystring, = 3 characters(CurrencyCode)

Currency code in ISO 4217 format.

Example:"USD"
customerIdstring, <= 50 characters(CustomerId)

ID of the customer resource.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
revisioninteger

Number of times the upcoming invoice data has changed.

Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation.

organizationIdstring, <= 50 characters(OrganizationId)

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Example:"org_0YVDM8RC7GDADADSBSMW124JA8"
itemsArray of objects(UpcomingInvoiceItem)

Upcoming invoice items array.

amountnumber, (double)read-only

Amount of the invoice.

amountDuenumber, (double)read-only

Amount that is due on the invoice.

subtotalAmountnumber, (double)read-only

Subtotal amount of the invoice.

discountAmountnumber, (double)read-only

Discount amount that is applied to the invoice.

shippingobject(Shipping)
taxobject(Taxes)
billingAddressobject(ContactObject)

Billing address of the invoice.

deliveryAddressobject(ContactObject)

Delivery address of the invoice.

poNumberstring or null

Purchase order number that is displayed on the invoice.

Example:"PO123456"
notesstring

Notes for the customer that are displayed on the invoice.

discountsArray of objectsread-only

Discounts applied.

isNewOrderbooleanread-only

Specifies if the order is a new order.

Example:true
dueTimestring, (date-time)

Date and time when the invoice is due for payment.

issuedTimestring, (date-time)(ServerTimestamp)read-only

Date and time when the invoice is issued.

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.

_embeddedobject

Embedded objects that are requested by the expand query parameter.

Response
{
  "id": "in_0YVF9605RKC62BP14NE2R7V2XT",
  "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  "subscriptionId": "sub_01HRF27SATGE4Z6PBJE6PD8328",
  "currency": "USD",
  "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  "revision": 0,
  "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8",
  "items": [
    { … }
  ],
  "amount": 0.1,
  "amountDue": 0.1,
  "subtotalAmount": 0.1,
  "discountAmount": 0.1,
  "shipping": {
    "amount": 0.1,
    "calculator": "manual"
  },
  "tax": {
    "calculator": "manual",
    "amount": 0.1,
    "items": [ … ]
  },
  "billingAddress": {
    "firstName": "Benjamin",
    "lastName": "Franklin",
    "organization": "Rebilly",
    "address": "36 Craven St",
    "address2": "string",
    "city": "Austin",
    "region": "Texas",
    "country": "GB",
    "postalCode": "WC2N 5NF",
    "phoneNumbers": [ … ],
    "emails": [ … ],
    "dob": "1980-04-01",
    "jobTitle": "CEO",
    "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
  },
  "deliveryAddress": {
    "firstName": "Benjamin",
    "lastName": "Franklin",
    "organization": "Rebilly",
    "address": "36 Craven St",
    "address2": "string",
    "city": "Austin",
    "region": "Texas",
    "country": "GB",
    "postalCode": "WC2N 5NF",
    "phoneNumbers": [ … ],
    "emails": [ … ],
    "dob": "1980-04-01",
    "jobTitle": "CEO",
    "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
  },
  "poNumber": "PO123456",
  "notes": "string",
  "discounts": [
    { … }
  ],
  "isNewOrder": true,
  "dueTime": "2019-08-24T14:15:22Z",
  "issuedTime": "2019-08-24T14:15:22Z",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ],
  "_embedded": {
    "customer": {},
    "website": {},
    "organization": {},
    "leadSource": {}
  }
}