Billing

Add a subscription to an account for the first time.

Returns an invoice object with information about the amount outstanding.

put/api/v1/billing/subscriptions/firsttimesubscription

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/billing/subscriptions/firsttimesubscription
  • 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
BillingRenewalTerm1 | 2 | 3 | 4

1 - Monthly, 2 - Yearly, 3 - Quarterly, 4 - One Time

Quantityinteger nullable
StartDatestring date-time
EndDatestring date-time nullable
ExpirationDatestring date-time nullable
RenewalDatestring date-time nullable
NewRequiredQuantityinteger nullable
IsPlanUpgradeRequiredboolean
PlanUpgradeRequiredMessagestring nullable
DiscountCodestring nullable
DiscountCouponExpirationDatestring date-time nullable
Ratenumber nullable

Example request

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "BillingRenewalTerm": 1,
  "Account": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "SchemaLessData": {},
    "StripeId": "string",
    "IsLivemode": false,
    "Name": "string",
    "ClientIdentifier": "string",
    "Currency": "string",
    "InvoiceNotes": "string",
    "IsDemo": false,
    "BillingAddress": {},
    "MailingAddress": {},
    "AccountStage": 2,
    "PaymentInformation": {},
    "PersonAccount": [],
    "StripeDefaultPaymentMethodId": "string",
    "StripeInvoices": [],
    "StripePaymentMethods": [],
    "StripeSubscriptions": [],
    "Subscriptions": [],
    "Deals": [],
    "LastLoginDateTime": "string",
    "AccountSpecificPageUrl1": "string",
    "AccountSpecificPageUrl2": "string",
    "AccountSpecificPageUrl3": "string",
    "AccountSpecificPageUrl4": "string",
    "AccountSpecificPageUrl5": "string",
    "AccountSpecificPageUrl6": "string",
    "AccountSpecificPageUrl7": "string",
    "AccountSpecificPageUrl8": "string",
    "AccountSpecificPageUrl9": "string",
    "AccountSpecificPageUrl10": "string",
    "RewardFulReferralId": "string",
    "ToltReferralId": "string",
    "TaxIds": [],
    "TaxStatus": "string",
    "AccountStageLabel": "string",
    "CurrentStripeProducts": "string",
    "CurrentStripeProductInstances": [],
    "CurrentSubscription": {},
    "DomainName": "string",
    "TenantBillingSystem": 1,
    "HasLoggedIn": false,
    "LatestSubscription": {},
    "LifetimeRevenue": 0,
    "NextStripeInvoiceDate": "string",
    "Nonce": "string",
    "PrimaryContact": {},
    "PrimarySubscription": {},
    "PrimaryStripeSubscription": {},
    "RecaptchaToken": "string",
    "StripeCheckoutMetadata": {},
    "StripeNextInvoiceSequence": 0,
    "StripePrice": [],
    "StripePriceIds": "string",
    "StripePromotionCode": "string",
    "TaxId": "string",
    "TaxIdIsInvalid": false,
    "TaxIdType": "string",
    "WebflowSlug": "string"
  },
  "Plan": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "Name": "string",
    "Description": "string",
    "PlanFamily": {},
    "AccountRegistrationMode": 1,
    "IsQuantityEditable": false,
    "MinimumQuantity": 0,
    "MaximumPeople": 0,
    "MonthlyRate": 0,
    "AnnualRate": 0,
    "QuarterlyRate": 0,
    "OneTimeRate": 0,
    "SetupFee": 0,
    "SkipSetupFeeOnPlanChange": false,
    "IsTaxable": false,
    "IsActive": false,
    "IsPerUser": false,
    "RequirePaymentInformation": false,
    "TrialPeriodDays": 0,
    "TrialUntilDate": "string",
    "ExpiresAfterMonths": 0,
    "ExpirationDate": "string",
    "PostLoginPath": "string",
    "StripeTaxCodeId": "string",
    "UnitOfMeasure": "string",
    "PlanAddOns": [],
    "ContentGroups": [],
    "NumberOfSubscriptions": 0
  },
  "Quantity": 0,
  "StartDate": "string",
  "EndDate": "string",
  "ExpirationDate": "string",
  "RenewalDate": "string",
  "NewRequiredQuantity": 0,
  "IsPlanUpgradeRequired": false,
  "PlanUpgradeRequiredMessage": "string",
  "SubscriptionAddOns": [
    {
      "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
    }
  ],
  "DiscountCouponSubscriptions": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "RedeemedDate": "string",
      "ExpireDate": "string",
      "Subscription": {},
      "DiscountCoupon": {}
    }
  ],
  "DiscountCode": "string",
  "DiscountCouponExpirationDate": "string",
  "LatestInvoice": {
    "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"
  },
  "Rate": 0
}

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.