Billing

Add a usage entry for an add-on that bills for usage at the end of the month.

post/api/v1/billing/usage

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/billing/usage
Auth: one of:
- HTTP bearer
- API key in header Authorization

Request body

Uidstring nullable

_objectTypestring nullable

Createdstring date-time required

Updatedstring date-time required

ActivityEventDataunknown

UsageDatestring date-time required

Amountnumber required

AdditionalUsageDatastring nullable

Example request

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "UsageDate": "string",
  "Invoice": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "InvoiceDate": "string",
    "PaymentReminderSentDate": "string",
    "Number": 0,
    "BillingInvoiceStatus": 1,
    "Subscription": {},
    "Amount": 0,
    "AmountOutstanding": 0,
    "InvoiceLineItems": [],
    "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"
  },
  "SubscriptionAddOn": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "BillingRenewalTerm": 1,
    "Subscription": {},
    "AddOn": {},
    "Quantity": 0,
    "StartDate": "string",
    "EndDate": "string",
    "ExpirationDate": "string",
    "RenewalDate": "string",
    "NewRequiredQuantity": 0,
    "Rate": 0
  },
  "Amount": 0,
  "AdditionalUsageData": "string"
}

Response