Preview the initial or renewal invoice for a hypothetical subscription.
curl --request POST \
--url https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary \
--header 'Content-Type: application/json' \
--data '
{
"Uid": "string",
"_objectType": "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",
"CurrentSubscription": {},
"DomainName": "string",
"HasLoggedIn": false,
"LatestSubscription": {},
"LifetimeRevenue": 0,
"NextStripeInvoiceDate": "string",
"Nonce": "string",
"PrimaryContact": {},
"PrimarySubscription": {},
"PrimaryStripeSubscription": {},
"RecaptchaToken": "string",
"StripeNextInvoiceSequence": 0,
"StripePrice": [],
"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
}
'import requests
url = "https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary"
payload = {
"Uid": "string",
"_objectType": "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",
"CurrentSubscription": {},
"DomainName": "string",
"HasLoggedIn": False,
"LatestSubscription": {},
"LifetimeRevenue": 0,
"NextStripeInvoiceDate": "string",
"Nonce": "string",
"PrimaryContact": {},
"PrimarySubscription": {},
"PrimaryStripeSubscription": {},
"RecaptchaToken": "string",
"StripeNextInvoiceSequence": 0,
"StripePrice": [],
"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
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Uid: 'string',
_objectType: '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',
CurrentSubscription: {},
DomainName: 'string',
HasLoggedIn: false,
LatestSubscription: {},
LifetimeRevenue: 0,
NextStripeInvoiceDate: 'string',
Nonce: 'string',
PrimaryContact: {},
PrimarySubscription: {},
PrimaryStripeSubscription: {},
RecaptchaToken: 'string',
StripeNextInvoiceSequence: 0,
StripePrice: [],
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
})
};
fetch('https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Uid' => 'string',
'_objectType' => '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',
'CurrentSubscription' => [
],
'DomainName' => 'string',
'HasLoggedIn' => false,
'LatestSubscription' => [
],
'LifetimeRevenue' => 0,
'NextStripeInvoiceDate' => 'string',
'Nonce' => 'string',
'PrimaryContact' => [
],
'PrimarySubscription' => [
],
'PrimaryStripeSubscription' => [
],
'RecaptchaToken' => 'string',
'StripeNextInvoiceSequence' => 0,
'StripePrice' => [
],
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary"
payload := strings.NewReader("{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"BillingRenewalTerm\": 1,\n \"Account\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"SchemaLessData\": {},\n \"StripeId\": \"string\",\n \"IsLivemode\": false,\n \"Name\": \"string\",\n \"ClientIdentifier\": \"string\",\n \"Currency\": \"string\",\n \"InvoiceNotes\": \"string\",\n \"IsDemo\": false,\n \"BillingAddress\": {},\n \"MailingAddress\": {},\n \"AccountStage\": 2,\n \"PaymentInformation\": {},\n \"PersonAccount\": [],\n \"StripeDefaultPaymentMethodId\": \"string\",\n \"StripeInvoices\": [],\n \"StripePaymentMethods\": [],\n \"StripeSubscriptions\": [],\n \"Subscriptions\": [],\n \"Deals\": [],\n \"LastLoginDateTime\": \"string\",\n \"AccountSpecificPageUrl1\": \"string\",\n \"AccountSpecificPageUrl2\": \"string\",\n \"AccountSpecificPageUrl3\": \"string\",\n \"AccountSpecificPageUrl4\": \"string\",\n \"AccountSpecificPageUrl5\": \"string\",\n \"AccountSpecificPageUrl6\": \"string\",\n \"AccountSpecificPageUrl7\": \"string\",\n \"AccountSpecificPageUrl8\": \"string\",\n \"AccountSpecificPageUrl9\": \"string\",\n \"AccountSpecificPageUrl10\": \"string\",\n \"RewardFulReferralId\": \"string\",\n \"ToltReferralId\": \"string\",\n \"TaxIds\": [],\n \"TaxStatus\": \"string\",\n \"AccountStageLabel\": \"string\",\n \"CurrentStripeProducts\": \"string\",\n \"CurrentSubscription\": {},\n \"DomainName\": \"string\",\n \"HasLoggedIn\": false,\n \"LatestSubscription\": {},\n \"LifetimeRevenue\": 0,\n \"NextStripeInvoiceDate\": \"string\",\n \"Nonce\": \"string\",\n \"PrimaryContact\": {},\n \"PrimarySubscription\": {},\n \"PrimaryStripeSubscription\": {},\n \"RecaptchaToken\": \"string\",\n \"StripeNextInvoiceSequence\": 0,\n \"StripePrice\": [],\n \"StripePromotionCode\": \"string\",\n \"TaxId\": \"string\",\n \"TaxIdIsInvalid\": false,\n \"TaxIdType\": \"string\",\n \"WebflowSlug\": \"string\"\n },\n \"Plan\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"PlanFamily\": {},\n \"AccountRegistrationMode\": 1,\n \"IsQuantityEditable\": false,\n \"MinimumQuantity\": 0,\n \"MaximumPeople\": 0,\n \"MonthlyRate\": 0,\n \"AnnualRate\": 0,\n \"QuarterlyRate\": 0,\n \"OneTimeRate\": 0,\n \"SetupFee\": 0,\n \"SkipSetupFeeOnPlanChange\": false,\n \"IsTaxable\": false,\n \"IsActive\": false,\n \"IsPerUser\": false,\n \"RequirePaymentInformation\": false,\n \"TrialPeriodDays\": 0,\n \"TrialUntilDate\": \"string\",\n \"ExpiresAfterMonths\": 0,\n \"ExpirationDate\": \"string\",\n \"PostLoginPath\": \"string\",\n \"StripeTaxCodeId\": \"string\",\n \"UnitOfMeasure\": \"string\",\n \"PlanAddOns\": [],\n \"ContentGroups\": [],\n \"NumberOfSubscriptions\": 0\n },\n \"Quantity\": 0,\n \"StartDate\": \"string\",\n \"EndDate\": \"string\",\n \"ExpirationDate\": \"string\",\n \"RenewalDate\": \"string\",\n \"NewRequiredQuantity\": 0,\n \"IsPlanUpgradeRequired\": false,\n \"PlanUpgradeRequiredMessage\": \"string\",\n \"SubscriptionAddOns\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"BillingRenewalTerm\": 1,\n \"Subscription\": {},\n \"AddOn\": {},\n \"Quantity\": 0,\n \"StartDate\": \"string\",\n \"EndDate\": \"string\",\n \"ExpirationDate\": \"string\",\n \"RenewalDate\": \"string\",\n \"NewRequiredQuantity\": 0,\n \"Rate\": 0\n }\n ],\n \"DiscountCouponSubscriptions\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"RedeemedDate\": \"string\",\n \"ExpireDate\": \"string\",\n \"Subscription\": {},\n \"DiscountCoupon\": {}\n }\n ],\n \"DiscountCode\": \"string\",\n \"DiscountCouponExpirationDate\": \"string\",\n \"LatestInvoice\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"InvoiceDate\": \"string\",\n \"PaymentReminderSentDate\": \"string\",\n \"Number\": 0,\n \"BillingInvoiceStatus\": 1,\n \"Subscription\": {},\n \"Amount\": 0,\n \"AmountOutstanding\": 0,\n \"InvoiceLineItems\": [],\n \"IsUserGenerated\": false,\n \"StripeTaxCalculationId\": \"string\",\n \"StripeTaxBehavior\": \"string\",\n \"AmountCredit\": 0,\n \"AmountDiscount\": 0,\n \"AmountPaid\": 0,\n \"AmountRefunded\": 0,\n \"AmountSubtotal\": 0,\n \"AmountTax\": 0,\n \"AmountTaxRefunded\": 0,\n \"IsTaxable\": false,\n \"HasPaymentGatewayTransactions\": false,\n \"StripePaymentTransactionIds\": \"string\",\n \"StripeRefundTransactionIds\": \"string\",\n \"StripeTaxRefundTransactionIds\": \"string\"\n },\n \"Rate\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary")
.header("Content-Type", "application/json")
.body("{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"BillingRenewalTerm\": 1,\n \"Account\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"SchemaLessData\": {},\n \"StripeId\": \"string\",\n \"IsLivemode\": false,\n \"Name\": \"string\",\n \"ClientIdentifier\": \"string\",\n \"Currency\": \"string\",\n \"InvoiceNotes\": \"string\",\n \"IsDemo\": false,\n \"BillingAddress\": {},\n \"MailingAddress\": {},\n \"AccountStage\": 2,\n \"PaymentInformation\": {},\n \"PersonAccount\": [],\n \"StripeDefaultPaymentMethodId\": \"string\",\n \"StripeInvoices\": [],\n \"StripePaymentMethods\": [],\n \"StripeSubscriptions\": [],\n \"Subscriptions\": [],\n \"Deals\": [],\n \"LastLoginDateTime\": \"string\",\n \"AccountSpecificPageUrl1\": \"string\",\n \"AccountSpecificPageUrl2\": \"string\",\n \"AccountSpecificPageUrl3\": \"string\",\n \"AccountSpecificPageUrl4\": \"string\",\n \"AccountSpecificPageUrl5\": \"string\",\n \"AccountSpecificPageUrl6\": \"string\",\n \"AccountSpecificPageUrl7\": \"string\",\n \"AccountSpecificPageUrl8\": \"string\",\n \"AccountSpecificPageUrl9\": \"string\",\n \"AccountSpecificPageUrl10\": \"string\",\n \"RewardFulReferralId\": \"string\",\n \"ToltReferralId\": \"string\",\n \"TaxIds\": [],\n \"TaxStatus\": \"string\",\n \"AccountStageLabel\": \"string\",\n \"CurrentStripeProducts\": \"string\",\n \"CurrentSubscription\": {},\n \"DomainName\": \"string\",\n \"HasLoggedIn\": false,\n \"LatestSubscription\": {},\n \"LifetimeRevenue\": 0,\n \"NextStripeInvoiceDate\": \"string\",\n \"Nonce\": \"string\",\n \"PrimaryContact\": {},\n \"PrimarySubscription\": {},\n \"PrimaryStripeSubscription\": {},\n \"RecaptchaToken\": \"string\",\n \"StripeNextInvoiceSequence\": 0,\n \"StripePrice\": [],\n \"StripePromotionCode\": \"string\",\n \"TaxId\": \"string\",\n \"TaxIdIsInvalid\": false,\n \"TaxIdType\": \"string\",\n \"WebflowSlug\": \"string\"\n },\n \"Plan\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"PlanFamily\": {},\n \"AccountRegistrationMode\": 1,\n \"IsQuantityEditable\": false,\n \"MinimumQuantity\": 0,\n \"MaximumPeople\": 0,\n \"MonthlyRate\": 0,\n \"AnnualRate\": 0,\n \"QuarterlyRate\": 0,\n \"OneTimeRate\": 0,\n \"SetupFee\": 0,\n \"SkipSetupFeeOnPlanChange\": false,\n \"IsTaxable\": false,\n \"IsActive\": false,\n \"IsPerUser\": false,\n \"RequirePaymentInformation\": false,\n \"TrialPeriodDays\": 0,\n \"TrialUntilDate\": \"string\",\n \"ExpiresAfterMonths\": 0,\n \"ExpirationDate\": \"string\",\n \"PostLoginPath\": \"string\",\n \"StripeTaxCodeId\": \"string\",\n \"UnitOfMeasure\": \"string\",\n \"PlanAddOns\": [],\n \"ContentGroups\": [],\n \"NumberOfSubscriptions\": 0\n },\n \"Quantity\": 0,\n \"StartDate\": \"string\",\n \"EndDate\": \"string\",\n \"ExpirationDate\": \"string\",\n \"RenewalDate\": \"string\",\n \"NewRequiredQuantity\": 0,\n \"IsPlanUpgradeRequired\": false,\n \"PlanUpgradeRequiredMessage\": \"string\",\n \"SubscriptionAddOns\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"BillingRenewalTerm\": 1,\n \"Subscription\": {},\n \"AddOn\": {},\n \"Quantity\": 0,\n \"StartDate\": \"string\",\n \"EndDate\": \"string\",\n \"ExpirationDate\": \"string\",\n \"RenewalDate\": \"string\",\n \"NewRequiredQuantity\": 0,\n \"Rate\": 0\n }\n ],\n \"DiscountCouponSubscriptions\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"RedeemedDate\": \"string\",\n \"ExpireDate\": \"string\",\n \"Subscription\": {},\n \"DiscountCoupon\": {}\n }\n ],\n \"DiscountCode\": \"string\",\n \"DiscountCouponExpirationDate\": \"string\",\n \"LatestInvoice\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"InvoiceDate\": \"string\",\n \"PaymentReminderSentDate\": \"string\",\n \"Number\": 0,\n \"BillingInvoiceStatus\": 1,\n \"Subscription\": {},\n \"Amount\": 0,\n \"AmountOutstanding\": 0,\n \"InvoiceLineItems\": [],\n \"IsUserGenerated\": false,\n \"StripeTaxCalculationId\": \"string\",\n \"StripeTaxBehavior\": \"string\",\n \"AmountCredit\": 0,\n \"AmountDiscount\": 0,\n \"AmountPaid\": 0,\n \"AmountRefunded\": 0,\n \"AmountSubtotal\": 0,\n \"AmountTax\": 0,\n \"AmountTaxRefunded\": 0,\n \"IsTaxable\": false,\n \"HasPaymentGatewayTransactions\": false,\n \"StripePaymentTransactionIds\": \"string\",\n \"StripeRefundTransactionIds\": \"string\",\n \"StripeTaxRefundTransactionIds\": \"string\"\n },\n \"Rate\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"BillingRenewalTerm\": 1,\n \"Account\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"SchemaLessData\": {},\n \"StripeId\": \"string\",\n \"IsLivemode\": false,\n \"Name\": \"string\",\n \"ClientIdentifier\": \"string\",\n \"Currency\": \"string\",\n \"InvoiceNotes\": \"string\",\n \"IsDemo\": false,\n \"BillingAddress\": {},\n \"MailingAddress\": {},\n \"AccountStage\": 2,\n \"PaymentInformation\": {},\n \"PersonAccount\": [],\n \"StripeDefaultPaymentMethodId\": \"string\",\n \"StripeInvoices\": [],\n \"StripePaymentMethods\": [],\n \"StripeSubscriptions\": [],\n \"Subscriptions\": [],\n \"Deals\": [],\n \"LastLoginDateTime\": \"string\",\n \"AccountSpecificPageUrl1\": \"string\",\n \"AccountSpecificPageUrl2\": \"string\",\n \"AccountSpecificPageUrl3\": \"string\",\n \"AccountSpecificPageUrl4\": \"string\",\n \"AccountSpecificPageUrl5\": \"string\",\n \"AccountSpecificPageUrl6\": \"string\",\n \"AccountSpecificPageUrl7\": \"string\",\n \"AccountSpecificPageUrl8\": \"string\",\n \"AccountSpecificPageUrl9\": \"string\",\n \"AccountSpecificPageUrl10\": \"string\",\n \"RewardFulReferralId\": \"string\",\n \"ToltReferralId\": \"string\",\n \"TaxIds\": [],\n \"TaxStatus\": \"string\",\n \"AccountStageLabel\": \"string\",\n \"CurrentStripeProducts\": \"string\",\n \"CurrentSubscription\": {},\n \"DomainName\": \"string\",\n \"HasLoggedIn\": false,\n \"LatestSubscription\": {},\n \"LifetimeRevenue\": 0,\n \"NextStripeInvoiceDate\": \"string\",\n \"Nonce\": \"string\",\n \"PrimaryContact\": {},\n \"PrimarySubscription\": {},\n \"PrimaryStripeSubscription\": {},\n \"RecaptchaToken\": \"string\",\n \"StripeNextInvoiceSequence\": 0,\n \"StripePrice\": [],\n \"StripePromotionCode\": \"string\",\n \"TaxId\": \"string\",\n \"TaxIdIsInvalid\": false,\n \"TaxIdType\": \"string\",\n \"WebflowSlug\": \"string\"\n },\n \"Plan\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"PlanFamily\": {},\n \"AccountRegistrationMode\": 1,\n \"IsQuantityEditable\": false,\n \"MinimumQuantity\": 0,\n \"MaximumPeople\": 0,\n \"MonthlyRate\": 0,\n \"AnnualRate\": 0,\n \"QuarterlyRate\": 0,\n \"OneTimeRate\": 0,\n \"SetupFee\": 0,\n \"SkipSetupFeeOnPlanChange\": false,\n \"IsTaxable\": false,\n \"IsActive\": false,\n \"IsPerUser\": false,\n \"RequirePaymentInformation\": false,\n \"TrialPeriodDays\": 0,\n \"TrialUntilDate\": \"string\",\n \"ExpiresAfterMonths\": 0,\n \"ExpirationDate\": \"string\",\n \"PostLoginPath\": \"string\",\n \"StripeTaxCodeId\": \"string\",\n \"UnitOfMeasure\": \"string\",\n \"PlanAddOns\": [],\n \"ContentGroups\": [],\n \"NumberOfSubscriptions\": 0\n },\n \"Quantity\": 0,\n \"StartDate\": \"string\",\n \"EndDate\": \"string\",\n \"ExpirationDate\": \"string\",\n \"RenewalDate\": \"string\",\n \"NewRequiredQuantity\": 0,\n \"IsPlanUpgradeRequired\": false,\n \"PlanUpgradeRequiredMessage\": \"string\",\n \"SubscriptionAddOns\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"BillingRenewalTerm\": 1,\n \"Subscription\": {},\n \"AddOn\": {},\n \"Quantity\": 0,\n \"StartDate\": \"string\",\n \"EndDate\": \"string\",\n \"ExpirationDate\": \"string\",\n \"RenewalDate\": \"string\",\n \"NewRequiredQuantity\": 0,\n \"Rate\": 0\n }\n ],\n \"DiscountCouponSubscriptions\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"RedeemedDate\": \"string\",\n \"ExpireDate\": \"string\",\n \"Subscription\": {},\n \"DiscountCoupon\": {}\n }\n ],\n \"DiscountCode\": \"string\",\n \"DiscountCouponExpirationDate\": \"string\",\n \"LatestInvoice\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"InvoiceDate\": \"string\",\n \"PaymentReminderSentDate\": \"string\",\n \"Number\": 0,\n \"BillingInvoiceStatus\": 1,\n \"Subscription\": {},\n \"Amount\": 0,\n \"AmountOutstanding\": 0,\n \"InvoiceLineItems\": [],\n \"IsUserGenerated\": false,\n \"StripeTaxCalculationId\": \"string\",\n \"StripeTaxBehavior\": \"string\",\n \"AmountCredit\": 0,\n \"AmountDiscount\": 0,\n \"AmountPaid\": 0,\n \"AmountRefunded\": 0,\n \"AmountSubtotal\": 0,\n \"AmountTax\": 0,\n \"AmountTaxRefunded\": 0,\n \"IsTaxable\": false,\n \"HasPaymentGatewayTransactions\": false,\n \"StripePaymentTransactionIds\": \"string\",\n \"StripeRefundTransactionIds\": \"string\",\n \"StripeTaxRefundTransactionIds\": \"string\"\n },\n \"Rate\": 0\n}"
response = http.request(request)
puts response.read_body{
"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"
}Subscriptions
Preview the initial or renewal invoice for a hypothetical subscription.
Returns an invoice object with information about the amount outstanding if an account were to register with this subscription. BillingRenewalTerm values: 1 = Monthly, 2 = Yearly, 3 = Quarterly, 4 = OneTime. Pass asOf=renewal to see the renewal invoice instead of the initial invoice.
POST
/
api
/
v1
/
billing
/
subscriptions
/
compute-charge-summary
Preview the initial or renewal invoice for a hypothetical subscription.
curl --request POST \
--url https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary \
--header 'Content-Type: application/json' \
--data '
{
"Uid": "string",
"_objectType": "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",
"CurrentSubscription": {},
"DomainName": "string",
"HasLoggedIn": false,
"LatestSubscription": {},
"LifetimeRevenue": 0,
"NextStripeInvoiceDate": "string",
"Nonce": "string",
"PrimaryContact": {},
"PrimarySubscription": {},
"PrimaryStripeSubscription": {},
"RecaptchaToken": "string",
"StripeNextInvoiceSequence": 0,
"StripePrice": [],
"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
}
'import requests
url = "https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary"
payload = {
"Uid": "string",
"_objectType": "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",
"CurrentSubscription": {},
"DomainName": "string",
"HasLoggedIn": False,
"LatestSubscription": {},
"LifetimeRevenue": 0,
"NextStripeInvoiceDate": "string",
"Nonce": "string",
"PrimaryContact": {},
"PrimarySubscription": {},
"PrimaryStripeSubscription": {},
"RecaptchaToken": "string",
"StripeNextInvoiceSequence": 0,
"StripePrice": [],
"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
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Uid: 'string',
_objectType: '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',
CurrentSubscription: {},
DomainName: 'string',
HasLoggedIn: false,
LatestSubscription: {},
LifetimeRevenue: 0,
NextStripeInvoiceDate: 'string',
Nonce: 'string',
PrimaryContact: {},
PrimarySubscription: {},
PrimaryStripeSubscription: {},
RecaptchaToken: 'string',
StripeNextInvoiceSequence: 0,
StripePrice: [],
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
})
};
fetch('https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Uid' => 'string',
'_objectType' => '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',
'CurrentSubscription' => [
],
'DomainName' => 'string',
'HasLoggedIn' => false,
'LatestSubscription' => [
],
'LifetimeRevenue' => 0,
'NextStripeInvoiceDate' => 'string',
'Nonce' => 'string',
'PrimaryContact' => [
],
'PrimarySubscription' => [
],
'PrimaryStripeSubscription' => [
],
'RecaptchaToken' => 'string',
'StripeNextInvoiceSequence' => 0,
'StripePrice' => [
],
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary"
payload := strings.NewReader("{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"BillingRenewalTerm\": 1,\n \"Account\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"SchemaLessData\": {},\n \"StripeId\": \"string\",\n \"IsLivemode\": false,\n \"Name\": \"string\",\n \"ClientIdentifier\": \"string\",\n \"Currency\": \"string\",\n \"InvoiceNotes\": \"string\",\n \"IsDemo\": false,\n \"BillingAddress\": {},\n \"MailingAddress\": {},\n \"AccountStage\": 2,\n \"PaymentInformation\": {},\n \"PersonAccount\": [],\n \"StripeDefaultPaymentMethodId\": \"string\",\n \"StripeInvoices\": [],\n \"StripePaymentMethods\": [],\n \"StripeSubscriptions\": [],\n \"Subscriptions\": [],\n \"Deals\": [],\n \"LastLoginDateTime\": \"string\",\n \"AccountSpecificPageUrl1\": \"string\",\n \"AccountSpecificPageUrl2\": \"string\",\n \"AccountSpecificPageUrl3\": \"string\",\n \"AccountSpecificPageUrl4\": \"string\",\n \"AccountSpecificPageUrl5\": \"string\",\n \"AccountSpecificPageUrl6\": \"string\",\n \"AccountSpecificPageUrl7\": \"string\",\n \"AccountSpecificPageUrl8\": \"string\",\n \"AccountSpecificPageUrl9\": \"string\",\n \"AccountSpecificPageUrl10\": \"string\",\n \"RewardFulReferralId\": \"string\",\n \"ToltReferralId\": \"string\",\n \"TaxIds\": [],\n \"TaxStatus\": \"string\",\n \"AccountStageLabel\": \"string\",\n \"CurrentStripeProducts\": \"string\",\n \"CurrentSubscription\": {},\n \"DomainName\": \"string\",\n \"HasLoggedIn\": false,\n \"LatestSubscription\": {},\n \"LifetimeRevenue\": 0,\n \"NextStripeInvoiceDate\": \"string\",\n \"Nonce\": \"string\",\n \"PrimaryContact\": {},\n \"PrimarySubscription\": {},\n \"PrimaryStripeSubscription\": {},\n \"RecaptchaToken\": \"string\",\n \"StripeNextInvoiceSequence\": 0,\n \"StripePrice\": [],\n \"StripePromotionCode\": \"string\",\n \"TaxId\": \"string\",\n \"TaxIdIsInvalid\": false,\n \"TaxIdType\": \"string\",\n \"WebflowSlug\": \"string\"\n },\n \"Plan\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"PlanFamily\": {},\n \"AccountRegistrationMode\": 1,\n \"IsQuantityEditable\": false,\n \"MinimumQuantity\": 0,\n \"MaximumPeople\": 0,\n \"MonthlyRate\": 0,\n \"AnnualRate\": 0,\n \"QuarterlyRate\": 0,\n \"OneTimeRate\": 0,\n \"SetupFee\": 0,\n \"SkipSetupFeeOnPlanChange\": false,\n \"IsTaxable\": false,\n \"IsActive\": false,\n \"IsPerUser\": false,\n \"RequirePaymentInformation\": false,\n \"TrialPeriodDays\": 0,\n \"TrialUntilDate\": \"string\",\n \"ExpiresAfterMonths\": 0,\n \"ExpirationDate\": \"string\",\n \"PostLoginPath\": \"string\",\n \"StripeTaxCodeId\": \"string\",\n \"UnitOfMeasure\": \"string\",\n \"PlanAddOns\": [],\n \"ContentGroups\": [],\n \"NumberOfSubscriptions\": 0\n },\n \"Quantity\": 0,\n \"StartDate\": \"string\",\n \"EndDate\": \"string\",\n \"ExpirationDate\": \"string\",\n \"RenewalDate\": \"string\",\n \"NewRequiredQuantity\": 0,\n \"IsPlanUpgradeRequired\": false,\n \"PlanUpgradeRequiredMessage\": \"string\",\n \"SubscriptionAddOns\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"BillingRenewalTerm\": 1,\n \"Subscription\": {},\n \"AddOn\": {},\n \"Quantity\": 0,\n \"StartDate\": \"string\",\n \"EndDate\": \"string\",\n \"ExpirationDate\": \"string\",\n \"RenewalDate\": \"string\",\n \"NewRequiredQuantity\": 0,\n \"Rate\": 0\n }\n ],\n \"DiscountCouponSubscriptions\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"RedeemedDate\": \"string\",\n \"ExpireDate\": \"string\",\n \"Subscription\": {},\n \"DiscountCoupon\": {}\n }\n ],\n \"DiscountCode\": \"string\",\n \"DiscountCouponExpirationDate\": \"string\",\n \"LatestInvoice\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"InvoiceDate\": \"string\",\n \"PaymentReminderSentDate\": \"string\",\n \"Number\": 0,\n \"BillingInvoiceStatus\": 1,\n \"Subscription\": {},\n \"Amount\": 0,\n \"AmountOutstanding\": 0,\n \"InvoiceLineItems\": [],\n \"IsUserGenerated\": false,\n \"StripeTaxCalculationId\": \"string\",\n \"StripeTaxBehavior\": \"string\",\n \"AmountCredit\": 0,\n \"AmountDiscount\": 0,\n \"AmountPaid\": 0,\n \"AmountRefunded\": 0,\n \"AmountSubtotal\": 0,\n \"AmountTax\": 0,\n \"AmountTaxRefunded\": 0,\n \"IsTaxable\": false,\n \"HasPaymentGatewayTransactions\": false,\n \"StripePaymentTransactionIds\": \"string\",\n \"StripeRefundTransactionIds\": \"string\",\n \"StripeTaxRefundTransactionIds\": \"string\"\n },\n \"Rate\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary")
.header("Content-Type", "application/json")
.body("{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"BillingRenewalTerm\": 1,\n \"Account\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"SchemaLessData\": {},\n \"StripeId\": \"string\",\n \"IsLivemode\": false,\n \"Name\": \"string\",\n \"ClientIdentifier\": \"string\",\n \"Currency\": \"string\",\n \"InvoiceNotes\": \"string\",\n \"IsDemo\": false,\n \"BillingAddress\": {},\n \"MailingAddress\": {},\n \"AccountStage\": 2,\n \"PaymentInformation\": {},\n \"PersonAccount\": [],\n \"StripeDefaultPaymentMethodId\": \"string\",\n \"StripeInvoices\": [],\n \"StripePaymentMethods\": [],\n \"StripeSubscriptions\": [],\n \"Subscriptions\": [],\n \"Deals\": [],\n \"LastLoginDateTime\": \"string\",\n \"AccountSpecificPageUrl1\": \"string\",\n \"AccountSpecificPageUrl2\": \"string\",\n \"AccountSpecificPageUrl3\": \"string\",\n \"AccountSpecificPageUrl4\": \"string\",\n \"AccountSpecificPageUrl5\": \"string\",\n \"AccountSpecificPageUrl6\": \"string\",\n \"AccountSpecificPageUrl7\": \"string\",\n \"AccountSpecificPageUrl8\": \"string\",\n \"AccountSpecificPageUrl9\": \"string\",\n \"AccountSpecificPageUrl10\": \"string\",\n \"RewardFulReferralId\": \"string\",\n \"ToltReferralId\": \"string\",\n \"TaxIds\": [],\n \"TaxStatus\": \"string\",\n \"AccountStageLabel\": \"string\",\n \"CurrentStripeProducts\": \"string\",\n \"CurrentSubscription\": {},\n \"DomainName\": \"string\",\n \"HasLoggedIn\": false,\n \"LatestSubscription\": {},\n \"LifetimeRevenue\": 0,\n \"NextStripeInvoiceDate\": \"string\",\n \"Nonce\": \"string\",\n \"PrimaryContact\": {},\n \"PrimarySubscription\": {},\n \"PrimaryStripeSubscription\": {},\n \"RecaptchaToken\": \"string\",\n \"StripeNextInvoiceSequence\": 0,\n \"StripePrice\": [],\n \"StripePromotionCode\": \"string\",\n \"TaxId\": \"string\",\n \"TaxIdIsInvalid\": false,\n \"TaxIdType\": \"string\",\n \"WebflowSlug\": \"string\"\n },\n \"Plan\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"PlanFamily\": {},\n \"AccountRegistrationMode\": 1,\n \"IsQuantityEditable\": false,\n \"MinimumQuantity\": 0,\n \"MaximumPeople\": 0,\n \"MonthlyRate\": 0,\n \"AnnualRate\": 0,\n \"QuarterlyRate\": 0,\n \"OneTimeRate\": 0,\n \"SetupFee\": 0,\n \"SkipSetupFeeOnPlanChange\": false,\n \"IsTaxable\": false,\n \"IsActive\": false,\n \"IsPerUser\": false,\n \"RequirePaymentInformation\": false,\n \"TrialPeriodDays\": 0,\n \"TrialUntilDate\": \"string\",\n \"ExpiresAfterMonths\": 0,\n \"ExpirationDate\": \"string\",\n \"PostLoginPath\": \"string\",\n \"StripeTaxCodeId\": \"string\",\n \"UnitOfMeasure\": \"string\",\n \"PlanAddOns\": [],\n \"ContentGroups\": [],\n \"NumberOfSubscriptions\": 0\n },\n \"Quantity\": 0,\n \"StartDate\": \"string\",\n \"EndDate\": \"string\",\n \"ExpirationDate\": \"string\",\n \"RenewalDate\": \"string\",\n \"NewRequiredQuantity\": 0,\n \"IsPlanUpgradeRequired\": false,\n \"PlanUpgradeRequiredMessage\": \"string\",\n \"SubscriptionAddOns\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"BillingRenewalTerm\": 1,\n \"Subscription\": {},\n \"AddOn\": {},\n \"Quantity\": 0,\n \"StartDate\": \"string\",\n \"EndDate\": \"string\",\n \"ExpirationDate\": \"string\",\n \"RenewalDate\": \"string\",\n \"NewRequiredQuantity\": 0,\n \"Rate\": 0\n }\n ],\n \"DiscountCouponSubscriptions\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"RedeemedDate\": \"string\",\n \"ExpireDate\": \"string\",\n \"Subscription\": {},\n \"DiscountCoupon\": {}\n }\n ],\n \"DiscountCode\": \"string\",\n \"DiscountCouponExpirationDate\": \"string\",\n \"LatestInvoice\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"InvoiceDate\": \"string\",\n \"PaymentReminderSentDate\": \"string\",\n \"Number\": 0,\n \"BillingInvoiceStatus\": 1,\n \"Subscription\": {},\n \"Amount\": 0,\n \"AmountOutstanding\": 0,\n \"InvoiceLineItems\": [],\n \"IsUserGenerated\": false,\n \"StripeTaxCalculationId\": \"string\",\n \"StripeTaxBehavior\": \"string\",\n \"AmountCredit\": 0,\n \"AmountDiscount\": 0,\n \"AmountPaid\": 0,\n \"AmountRefunded\": 0,\n \"AmountSubtotal\": 0,\n \"AmountTax\": 0,\n \"AmountTaxRefunded\": 0,\n \"IsTaxable\": false,\n \"HasPaymentGatewayTransactions\": false,\n \"StripePaymentTransactionIds\": \"string\",\n \"StripeRefundTransactionIds\": \"string\",\n \"StripeTaxRefundTransactionIds\": \"string\"\n },\n \"Rate\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.outseta.com/api/v1/billing/subscriptions/compute-charge-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"BillingRenewalTerm\": 1,\n \"Account\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"SchemaLessData\": {},\n \"StripeId\": \"string\",\n \"IsLivemode\": false,\n \"Name\": \"string\",\n \"ClientIdentifier\": \"string\",\n \"Currency\": \"string\",\n \"InvoiceNotes\": \"string\",\n \"IsDemo\": false,\n \"BillingAddress\": {},\n \"MailingAddress\": {},\n \"AccountStage\": 2,\n \"PaymentInformation\": {},\n \"PersonAccount\": [],\n \"StripeDefaultPaymentMethodId\": \"string\",\n \"StripeInvoices\": [],\n \"StripePaymentMethods\": [],\n \"StripeSubscriptions\": [],\n \"Subscriptions\": [],\n \"Deals\": [],\n \"LastLoginDateTime\": \"string\",\n \"AccountSpecificPageUrl1\": \"string\",\n \"AccountSpecificPageUrl2\": \"string\",\n \"AccountSpecificPageUrl3\": \"string\",\n \"AccountSpecificPageUrl4\": \"string\",\n \"AccountSpecificPageUrl5\": \"string\",\n \"AccountSpecificPageUrl6\": \"string\",\n \"AccountSpecificPageUrl7\": \"string\",\n \"AccountSpecificPageUrl8\": \"string\",\n \"AccountSpecificPageUrl9\": \"string\",\n \"AccountSpecificPageUrl10\": \"string\",\n \"RewardFulReferralId\": \"string\",\n \"ToltReferralId\": \"string\",\n \"TaxIds\": [],\n \"TaxStatus\": \"string\",\n \"AccountStageLabel\": \"string\",\n \"CurrentStripeProducts\": \"string\",\n \"CurrentSubscription\": {},\n \"DomainName\": \"string\",\n \"HasLoggedIn\": false,\n \"LatestSubscription\": {},\n \"LifetimeRevenue\": 0,\n \"NextStripeInvoiceDate\": \"string\",\n \"Nonce\": \"string\",\n \"PrimaryContact\": {},\n \"PrimarySubscription\": {},\n \"PrimaryStripeSubscription\": {},\n \"RecaptchaToken\": \"string\",\n \"StripeNextInvoiceSequence\": 0,\n \"StripePrice\": [],\n \"StripePromotionCode\": \"string\",\n \"TaxId\": \"string\",\n \"TaxIdIsInvalid\": false,\n \"TaxIdType\": \"string\",\n \"WebflowSlug\": \"string\"\n },\n \"Plan\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"PlanFamily\": {},\n \"AccountRegistrationMode\": 1,\n \"IsQuantityEditable\": false,\n \"MinimumQuantity\": 0,\n \"MaximumPeople\": 0,\n \"MonthlyRate\": 0,\n \"AnnualRate\": 0,\n \"QuarterlyRate\": 0,\n \"OneTimeRate\": 0,\n \"SetupFee\": 0,\n \"SkipSetupFeeOnPlanChange\": false,\n \"IsTaxable\": false,\n \"IsActive\": false,\n \"IsPerUser\": false,\n \"RequirePaymentInformation\": false,\n \"TrialPeriodDays\": 0,\n \"TrialUntilDate\": \"string\",\n \"ExpiresAfterMonths\": 0,\n \"ExpirationDate\": \"string\",\n \"PostLoginPath\": \"string\",\n \"StripeTaxCodeId\": \"string\",\n \"UnitOfMeasure\": \"string\",\n \"PlanAddOns\": [],\n \"ContentGroups\": [],\n \"NumberOfSubscriptions\": 0\n },\n \"Quantity\": 0,\n \"StartDate\": \"string\",\n \"EndDate\": \"string\",\n \"ExpirationDate\": \"string\",\n \"RenewalDate\": \"string\",\n \"NewRequiredQuantity\": 0,\n \"IsPlanUpgradeRequired\": false,\n \"PlanUpgradeRequiredMessage\": \"string\",\n \"SubscriptionAddOns\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"BillingRenewalTerm\": 1,\n \"Subscription\": {},\n \"AddOn\": {},\n \"Quantity\": 0,\n \"StartDate\": \"string\",\n \"EndDate\": \"string\",\n \"ExpirationDate\": \"string\",\n \"RenewalDate\": \"string\",\n \"NewRequiredQuantity\": 0,\n \"Rate\": 0\n }\n ],\n \"DiscountCouponSubscriptions\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"RedeemedDate\": \"string\",\n \"ExpireDate\": \"string\",\n \"Subscription\": {},\n \"DiscountCoupon\": {}\n }\n ],\n \"DiscountCode\": \"string\",\n \"DiscountCouponExpirationDate\": \"string\",\n \"LatestInvoice\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"InvoiceDate\": \"string\",\n \"PaymentReminderSentDate\": \"string\",\n \"Number\": 0,\n \"BillingInvoiceStatus\": 1,\n \"Subscription\": {},\n \"Amount\": 0,\n \"AmountOutstanding\": 0,\n \"InvoiceLineItems\": [],\n \"IsUserGenerated\": false,\n \"StripeTaxCalculationId\": \"string\",\n \"StripeTaxBehavior\": \"string\",\n \"AmountCredit\": 0,\n \"AmountDiscount\": 0,\n \"AmountPaid\": 0,\n \"AmountRefunded\": 0,\n \"AmountSubtotal\": 0,\n \"AmountTax\": 0,\n \"AmountTaxRefunded\": 0,\n \"IsTaxable\": false,\n \"HasPaymentGatewayTransactions\": false,\n \"StripePaymentTransactionIds\": \"string\",\n \"StripeRefundTransactionIds\": \"string\",\n \"StripeTaxRefundTransactionIds\": \"string\"\n },\n \"Rate\": 0\n}"
response = http.request(request)
puts response.read_body{
"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"
}Query Parameters
Set to "renewal" to see the renewal invoice. Defaults to "now".
Body
application/json
The subscription to preview
Maximum string length:
101 - Monthly, 2 - Yearly, 3 - Quarterly, 4 - One Time
Available options:
1, 2, 3, 4 Required range:
1 <= x <= 4Circular reference to Account (not expanded here).
Show child attributes
Show child attributes
Example:
{
"Uid": "string",
"_objectType": "string",
"ActivityEventData": {},
"Name": "string",
"Description": "string",
"PlanFamily": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"SchemaLessData": {},
"Name": "string",
"IsActive": false,
"IsDefault": false,
"Plans": []
},
"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": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Plan": {},
"AddOn": {},
"IsUserSelectable": false
}
],
"ContentGroups": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"AccessDeniedPath": "string",
"ContentGroupItems": [],
"AllowedPlans": [],
"AllowedProducts": [],
"AllowedAddOns": []
}
],
"NumberOfSubscriptions": 0
}
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
{
"Uid": "string",
"_objectType": "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"
}
Response
200 - application/json
Minimum string length:
1Minimum string length:
1Maximum string length:
101 - Unpaid, 2 - Paid, 3 - Partial, 4 - Uncollected, 5 - Refunded, 6 - Uncollectible, 7 - Processing
Available options:
1, 2, 3, 4, 5, 6, 7 Circular reference to Subscription (not expanded here).
Show child attributes
Show child attributes
Maximum string length:
50Maximum string length:
10⌘I