Issue an interim invoice

Issues an interim invoice for a subscription order. Use this operation for plan changes and pro rata adjustments.

This process:

  • Creates an invoice.
  • Adds the subscription line items to the invoice.
  • Issues the invoice.
  • Optionally, applies payment to the invoice if a transactionId is supplied.
SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Request Body schema: application/json

Issue an interim invoice.

transactionId
string (TransactionId) <= 50 characters

ID of the transaction.

post
/subscriptions/{id}/interim-invoice
Request samples
application/json
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0" }
Responses

201

Invoice created.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

Response samples
application/json
{ "id": "in_0YVF9605RKC62BP14NE2R7V2XT", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "invoiceNumber": 0, "orderId": "ord_01GYJPRKHBD6ZYHH897QCJMBS4", "subscriptionId": "sub_01HRF27SATGE4Z6PBJE6PD8328", "quoteId": "qt_0YV7DES3WPC5J8JD8QTVNZBZNZ", "currency": "USD", "amount": 0.1, "amountDue": 0.1, "subtotalAmount": 0.1, "discountAmount": 0.1, "shipping": { "amount": 0.1, "calculator": "manual" }, "tax": { "calculator": "manual", "amount": 0, }, "organizationTaxIdNumber": { "type": "eu-vat", "value": "GB980780684" }, "customerTaxIdNumber": { "type": "eu-vat", "value": "GB980780684" }, "billingAddress": { "firstName": "Benjamin", "lastName": "Franklin", "organization": "Rebilly", "address": "36 Craven St", "address2": "string", "city": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "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", "dob": "1980-04-01", "jobTitle": "CEO", "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221" }, "poNumber": "PO123456", "notes": "string", "items": [ ], "discounts": [ ], "autopayScheduledTime": "2019-08-24T14:15:22Z", "autopayRetryNumber": 0, "status": "draft", "delinquentCollectionPeriod": 0, "collectionPeriod": 0, "abandonedTime": "2019-08-24T14:15:22Z", "voidedTime": "2019-08-24T14:15:22Z", "paidTime": "2019-08-24T14:15:22Z", "dueTime": "2019-08-24T14:15:22Z", "issuedTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "paymentFormUrl": "string", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "transactions": [ ], "retryInstruction": { }, "revision": 0, "type": "initial", "dueReminderTime": "2019-08-24T14:15:22Z", "dueReminderNumber": 0, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "delinquencyTime": null, "_links": [ ], "_embedded": { "customer": { }, "website": { }, "organization": { }, "leadSource": { }, "shippingRate": { } } }