Billing

Retrieve an invoice.

get/api/v1/billing/invoices/{invoiceUid}

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/billing/invoices/{invoiceUid}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

invoiceUidstring nullable required

The invoice's unique identifier

Response

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
InvoiceDatestring date-time
PaymentReminderSentDatestring date-time nullable
Numberinteger
BillingInvoiceStatus1 | 2 | 3 | 4 | 5 | 6 | 7

1 - Unpaid, 2 - Paid, 3 - Partial, 4 - Uncollected, 5 - Refunded, 6 - Uncollectible, 7 - Processing

Amountnumber
AmountOutstandingnumber
IsUserGeneratedboolean
StripeTaxCalculationIdstring nullable
StripeTaxBehaviorstring nullable
AmountCreditnumber
AmountDiscountnumber
AmountPaidnumber
AmountRefundednumber
AmountSubtotalnumber
AmountTaxnumber
AmountTaxRefundednumber
IsTaxableboolean
HasPaymentGatewayTransactionsboolean
StripePaymentTransactionIdsstring nullable
StripeRefundTransactionIdsstring nullable
StripeTaxRefundTransactionIdsstring nullable

Example response

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "InvoiceDate": "string",
  "PaymentReminderSentDate": "string",
  "Number": 0,
  "BillingInvoiceStatus": 1,
  "Subscription": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "BillingRenewalTerm": 1,
    "Account": {},
    "Plan": {},
    "Quantity": 0,
    "StartDate": "string",
    "EndDate": "string",
    "ExpirationDate": "string",
    "RenewalDate": "string",
    "NewRequiredQuantity": 0,
    "IsPlanUpgradeRequired": false,
    "PlanUpgradeRequiredMessage": "string",
    "SubscriptionAddOns": [],
    "DiscountCouponSubscriptions": [],
    "DiscountCode": "string",
    "DiscountCouponExpirationDate": "string",
    "LatestInvoice": {},
    "Rate": 0
  },
  "Amount": 0,
  "AmountOutstanding": 0,
  "InvoiceLineItems": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "StartDate": "string",
      "EndDate": "string",
      "Description": "string",
      "UnitOfMeasure": "string",
      "Quantity": 0,
      "Rate": 0,
      "Amount": 0,
      "Tax": 0,
      "Invoice": {},
      "LineItemType": 1,
      "EntityId": 0,
      "StripeTaxReference": "string",
      "StripeTaxLineItemId": "string",
      "EntityUid": "string"
    }
  ],
  "IsUserGenerated": false,
  "StripeTaxCalculationId": "string",
  "StripeTaxBehavior": "string",
  "AmountCredit": 0,
  "AmountDiscount": 0,
  "AmountPaid": 0,
  "AmountRefunded": 0,
  "AmountSubtotal": 0,
  "AmountTax": 0,
  "AmountTaxRefunded": 0,
  "IsTaxable": false,
  "HasPaymentGatewayTransactions": false,
  "StripePaymentTransactionIds": "string",
  "StripeRefundTransactionIds": "string",
  "StripeTaxRefundTransactionIds": "string"
}

Changes

No recorded changes to this operation across all 1 revision of this API.