Get Subscriptions
curl --request GET \
--url https://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions \
--header 'X-API-KEY: <api-key>'import requests
url = "https://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions', 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://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"total_count": 123,
"data": [
{
"object": "Subscription",
"id": "<string>",
"account": {
"id": "<string>",
"object": "Account",
"vid": "<string>",
"external_id": "<string>",
"created": "<string>",
"parent": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"default_currency": "<string>",
"email": "<string>",
"email_type": "html",
"language": "<string>",
"notify_before_billing": true,
"company": "<string>",
"name": "<string>",
"shipping_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"payment_methods": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
}
]
},
"metadata": {},
"tax_exemptions": [
{
"object": "TaxExemption",
"region": "<string>",
"exemption_id": "<string>",
"active": true
}
],
"tokens": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"credit": [
{
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
}
],
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"tax_use_code": "<string>"
},
"status": "Pending Activation",
"items": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "SubscriptionItem",
"id": "<string>",
"product": {
"object": "Product",
"id": "<string>",
"descriptions": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "ProductDescription",
"language": "<string>",
"description": "<string>"
}
]
},
"status": "Active",
"vid": "<string>",
"created": "<string>",
"tax_classification": "<string>",
"br_tax_category": "Goods",
"default_billing_plan": {
"id": "<string>",
"vid": "<string>",
"object": "BillingPlan",
"created": "<string>",
"description": "<string>",
"status": "Active",
"tax_classification": "<string>",
"br_tax_category": "<string>",
"trial": {
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
},
"periods": [
{
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
}
],
"billing_notification_days": 123,
"trial_end_notification_days": 123,
"skip_initial_billing_notification": true,
"end_of_life": "<string>",
"metadata": {},
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"billing_descriptor": "<string>",
"times_to_run": "<string>",
"entitlements_valid_for": "<string>",
"repeat_every": "<string>",
"season_set": {
"id": "<string>",
"vid": "<string>",
"object": "SeasonSet",
"created": "<string>",
"seasons": [
{
"object": "Season",
"description": "<string>",
"starts": "<string>",
"ends": "<string>"
}
],
"metadata": {}
},
"days_before_season_to_bill": 123,
"days_entitled_before_season": 123,
"days_entitled_after_season": 123,
"entitled_off_season": true,
"used_on_subscriptions": true,
"grace_period_override": 123
},
"default_rate_plan": {
"object": "RatePlan",
"id": "<string>",
"vid": "<string>"
},
"end_of_life": "<string>",
"metadata": {},
"entitlements": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
]
},
"inherited_entitlements": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
]
},
"billing_descriptor": "<string>",
"credit_granted": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"prices": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "ProductPrice",
"amount": 123,
"currency": "<string>",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
}
}
]
},
"bundled_products": "<array>"
},
"vid": "<string>",
"index": 123,
"campaign_id": "<string>",
"amount": 123,
"currency": "<string>",
"rate_plan": {
"object": "RatePlan",
"id": "<string>",
"vid": "<string>"
},
"metadata": {},
"quantity": 123,
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"cycles": 123,
"cycles_remaining": 123,
"created": "<string>",
"ends": "<string>",
"starts": "<string>",
"discount_tickets": [
{}
],
"replaces": "<unknown>",
"replaced_by": "<unknown>"
}
]
},
"vid": "<string>",
"created": "<string>",
"billing_plan": {
"id": "<string>",
"vid": "<string>",
"object": "BillingPlan",
"created": "<string>",
"description": "<string>",
"status": "Active",
"tax_classification": "<string>",
"br_tax_category": "<string>",
"trial": {
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
},
"periods": [
{
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
}
],
"billing_notification_days": 123,
"trial_end_notification_days": 123,
"skip_initial_billing_notification": true,
"end_of_life": "<string>",
"metadata": {},
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"billing_descriptor": "<string>",
"times_to_run": "<string>",
"entitlements_valid_for": "<string>",
"repeat_every": "<string>",
"season_set": {
"id": "<string>",
"vid": "<string>",
"object": "SeasonSet",
"created": "<string>",
"seasons": [
{
"object": "Season",
"description": "<string>",
"starts": "<string>",
"ends": "<string>"
}
],
"metadata": {}
},
"days_before_season_to_bill": 123,
"days_entitled_before_season": 123,
"days_entitled_after_season": 123,
"entitled_off_season": true,
"used_on_subscriptions": true,
"grace_period_override": 123
},
"payment_method": {
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
},
"currency": "<string>",
"billing_state": "Free/Trial",
"starts": "<string>",
"ends": "<string>",
"entitled_through": "<string>",
"source_ip": "<string>",
"billing_descriptor": "<string>",
"billing_day": 123,
"minimum_commitment": 123,
"affiliate": "<string>",
"sub_affiliate": "<string>",
"notify_on_transition": true,
"most_recent_billing": {
"object": "Transaction",
"id": "<string>",
"vid": "<string>",
"created": "<string>",
"amount": 123,
"original_amount": 123,
"currency": "<string>",
"division_number": "<string>",
"previous_id": "<string>",
"account": {
"id": "<string>",
"object": "Account",
"vid": "<string>",
"external_id": "<string>",
"created": "<string>",
"parent": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"default_currency": "<string>",
"email": "<string>",
"email_type": "html",
"language": "<string>",
"notify_before_billing": true,
"company": "<string>",
"name": "<string>",
"shipping_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"payment_methods": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
}
]
},
"metadata": {},
"tax_exemptions": [
{
"object": "TaxExemption",
"region": "<string>",
"exemption_id": "<string>",
"active": true
}
],
"tokens": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"credit": [
{
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
}
],
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"tax_use_code": "<string>"
},
"source_payment_method": {
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
},
"dest_payment_method": {
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
},
"ecp_transaction_type": "All",
"status_log": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
}
]
},
"payment_processor": "<string>",
"payment_processor_transaction_id": "<string>",
"shipping_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"metadata": {},
"items": [
{
"object": "TransactionItem",
"sku": "<string>",
"index_number": 123,
"item_type": "<string>",
"name": "<string>",
"subscription_item": {
"object": "SubscriptionItem",
"id": "<string>",
"product": {
"object": "Product",
"id": "<string>",
"descriptions": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "ProductDescription",
"language": "<string>",
"description": "<string>"
}
]
},
"status": "Active",
"vid": "<string>",
"created": "<string>",
"tax_classification": "<string>",
"br_tax_category": "Goods",
"default_billing_plan": {
"id": "<string>",
"vid": "<string>",
"object": "BillingPlan",
"created": "<string>",
"description": "<string>",
"status": "Active",
"tax_classification": "<string>",
"br_tax_category": "<string>",
"trial": {
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
},
"periods": [
{
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
}
],
"billing_notification_days": 123,
"trial_end_notification_days": 123,
"skip_initial_billing_notification": true,
"end_of_life": "<string>",
"metadata": {},
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"billing_descriptor": "<string>",
"times_to_run": "<string>",
"entitlements_valid_for": "<string>",
"repeat_every": "<string>",
"season_set": {
"id": "<string>",
"vid": "<string>",
"object": "SeasonSet",
"created": "<string>",
"seasons": [
{
"object": "Season",
"description": "<string>",
"starts": "<string>",
"ends": "<string>"
}
],
"metadata": {}
},
"days_before_season_to_bill": 123,
"days_entitled_before_season": 123,
"days_entitled_after_season": 123,
"entitled_off_season": true,
"used_on_subscriptions": true,
"grace_period_override": 123
},
"default_rate_plan": {
"object": "RatePlan",
"id": "<string>",
"vid": "<string>"
},
"end_of_life": "<string>",
"metadata": {},
"entitlements": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
]
},
"inherited_entitlements": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
]
},
"billing_descriptor": "<string>",
"credit_granted": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"prices": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "ProductPrice",
"amount": 123,
"currency": "<string>",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
}
}
]
},
"bundled_products": "<array>"
},
"vid": "<string>",
"index": 123,
"campaign_id": "<string>",
"amount": 123,
"currency": "<string>",
"rate_plan": {
"object": "RatePlan",
"id": "<string>",
"vid": "<string>"
},
"metadata": {},
"quantity": 123,
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"cycles": 123,
"cycles_remaining": 123,
"created": "<string>",
"ends": "<string>",
"starts": "<string>",
"discount_tickets": [
{}
],
"replaces": "<unknown>",
"replaced_by": "<unknown>"
},
"price": 123,
"metadata": {},
"quantity": 123,
"tax_classification": "<string>",
"tokens": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"campaign_code": "<string>",
"campaign_id": "<string>",
"campaign_description": "<string>",
"service_period_starts": "<string>",
"service_period_ends": "<string>",
"tax_type": "<string>",
"tax": {
"object": "<string>",
"data": [
{
"object": "<string>",
"jurisdiction": "<string>",
"name": "<string>",
"amount": 123,
"external_tax_name": "<string>",
"external_tax_category": "<string>",
"external_jurisdiction_name": "<string>",
"tax_rate": 123,
"external_tax_identifier": "<string>"
}
],
"total_count": 123
},
"related_transactions": [
"<string>"
],
"item_refunds": [
{
"created": "<string>",
"amount": "<string>",
"tax": 123,
"tax_only": true,
"refund": {
"object": "Refund",
"id": "<string>",
"vid": "<string>",
"created": "<string>",
"transaction": "<unknown>",
"refund_items": [
{
"transaction_item_index_number": 123,
"sku": "<string>",
"description": "<string>",
"amount": 123,
"tax_only": true,
"taxes": [
{
"object": "<string>",
"jurisdiction": "<string>",
"name": "<string>",
"amount": 123,
"external_tax_name": "<string>",
"external_tax_category": "<string>",
"external_jurisdiction_name": "<string>",
"tax_rate": 123,
"external_tax_identifier": "<string>"
}
]
}
],
"refund_distribution_strategy": "None",
"amount": 123,
"amount_includes_tax": true,
"currency": "<string>",
"metadata": {},
"reference_string": "<string>",
"note": "<string>",
"token_action": "CancelNegativeBalance",
"credit": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"status": "Complete"
}
}
],
"discount": 123,
"subtotal": 123,
"total": 123
}
],
"affiliate": "<string>",
"sub_affiliate": "<string>",
"user_agent": "<string>",
"preferred_notification_language": "<string>",
"source_mac_address": "<string>",
"source_ip": "<string>",
"billing_descriptor": "<string>",
"sales_tax_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"verification_code": "<string>",
"subscription_sequence": 123,
"billing_plan_sequence": 123,
"mandate": {
"object": "Mandate",
"created": "<string>",
"identifier": "<string>",
"status": "Active"
},
"original_billing_date": "<string>",
"billing_attempt": 123,
"subscription": "<unknown>",
"score": 123,
"score_calculated": "<string>",
"score_calculated_orig": "<string>",
"score_codes": [
{
"object": "ScoreCode",
"id": "<string>",
"description": "<string>"
}
],
"distance_ip_ba": 123,
"avs_code": "<string>",
"cvn_code": "<string>",
"cvn_checked": true,
"policy": [
"<string>"
],
"to_be_captured": true
},
"most_recent_refunds": [
{
"object": "Refund",
"id": "<string>",
"vid": "<string>",
"created": "<string>",
"transaction": "<unknown>",
"refund_items": [
{
"transaction_item_index_number": 123,
"sku": "<string>",
"description": "<string>",
"amount": 123,
"tax_only": true,
"taxes": [
{
"object": "<string>",
"jurisdiction": "<string>",
"name": "<string>",
"amount": 123,
"external_tax_name": "<string>",
"external_tax_category": "<string>",
"external_jurisdiction_name": "<string>",
"tax_rate": 123,
"external_tax_identifier": "<string>"
}
]
}
],
"refund_distribution_strategy": "None",
"amount": 123,
"amount_includes_tax": true,
"currency": "<string>",
"metadata": {},
"reference_string": "<string>",
"note": "<string>",
"token_action": "CancelNegativeBalance",
"credit": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"status": "Complete"
}
],
"next_billing": {
"object": "Transaction",
"id": "<string>",
"vid": "<string>",
"created": "<string>",
"amount": 123,
"original_amount": 123,
"currency": "<string>",
"division_number": "<string>",
"previous_id": "<string>",
"account": {
"id": "<string>",
"object": "Account",
"vid": "<string>",
"external_id": "<string>",
"created": "<string>",
"parent": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"default_currency": "<string>",
"email": "<string>",
"email_type": "html",
"language": "<string>",
"notify_before_billing": true,
"company": "<string>",
"name": "<string>",
"shipping_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"payment_methods": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
}
]
},
"metadata": {},
"tax_exemptions": [
{
"object": "TaxExemption",
"region": "<string>",
"exemption_id": "<string>",
"active": true
}
],
"tokens": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"credit": [
{
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
}
],
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"tax_use_code": "<string>"
},
"source_payment_method": {
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
},
"dest_payment_method": {
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
},
"ecp_transaction_type": "All",
"status_log": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
}
]
},
"payment_processor": "<string>",
"payment_processor_transaction_id": "<string>",
"shipping_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"metadata": {},
"items": [
{
"object": "TransactionItem",
"sku": "<string>",
"index_number": 123,
"item_type": "<string>",
"name": "<string>",
"subscription_item": {
"object": "SubscriptionItem",
"id": "<string>",
"product": {
"object": "Product",
"id": "<string>",
"descriptions": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "ProductDescription",
"language": "<string>",
"description": "<string>"
}
]
},
"status": "Active",
"vid": "<string>",
"created": "<string>",
"tax_classification": "<string>",
"br_tax_category": "Goods",
"default_billing_plan": {
"id": "<string>",
"vid": "<string>",
"object": "BillingPlan",
"created": "<string>",
"description": "<string>",
"status": "Active",
"tax_classification": "<string>",
"br_tax_category": "<string>",
"trial": {
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
},
"periods": [
{
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
}
],
"billing_notification_days": 123,
"trial_end_notification_days": 123,
"skip_initial_billing_notification": true,
"end_of_life": "<string>",
"metadata": {},
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"billing_descriptor": "<string>",
"times_to_run": "<string>",
"entitlements_valid_for": "<string>",
"repeat_every": "<string>",
"season_set": {
"id": "<string>",
"vid": "<string>",
"object": "SeasonSet",
"created": "<string>",
"seasons": [
{
"object": "Season",
"description": "<string>",
"starts": "<string>",
"ends": "<string>"
}
],
"metadata": {}
},
"days_before_season_to_bill": 123,
"days_entitled_before_season": 123,
"days_entitled_after_season": 123,
"entitled_off_season": true,
"used_on_subscriptions": true,
"grace_period_override": 123
},
"default_rate_plan": {
"object": "RatePlan",
"id": "<string>",
"vid": "<string>"
},
"end_of_life": "<string>",
"metadata": {},
"entitlements": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
]
},
"inherited_entitlements": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
]
},
"billing_descriptor": "<string>",
"credit_granted": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"prices": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "ProductPrice",
"amount": 123,
"currency": "<string>",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
}
}
]
},
"bundled_products": "<array>"
},
"vid": "<string>",
"index": 123,
"campaign_id": "<string>",
"amount": 123,
"currency": "<string>",
"rate_plan": {
"object": "RatePlan",
"id": "<string>",
"vid": "<string>"
},
"metadata": {},
"quantity": 123,
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"cycles": 123,
"cycles_remaining": 123,
"created": "<string>",
"ends": "<string>",
"starts": "<string>",
"discount_tickets": [
{}
],
"replaces": "<unknown>",
"replaced_by": "<unknown>"
},
"price": 123,
"metadata": {},
"quantity": 123,
"tax_classification": "<string>",
"tokens": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"campaign_code": "<string>",
"campaign_id": "<string>",
"campaign_description": "<string>",
"service_period_starts": "<string>",
"service_period_ends": "<string>",
"tax_type": "<string>",
"tax": {
"object": "<string>",
"data": [
{
"object": "<string>",
"jurisdiction": "<string>",
"name": "<string>",
"amount": 123,
"external_tax_name": "<string>",
"external_tax_category": "<string>",
"external_jurisdiction_name": "<string>",
"tax_rate": 123,
"external_tax_identifier": "<string>"
}
],
"total_count": 123
},
"related_transactions": [
"<string>"
],
"item_refunds": [
{
"created": "<string>",
"amount": "<string>",
"tax": 123,
"tax_only": true,
"refund": {
"object": "Refund",
"id": "<string>",
"vid": "<string>",
"created": "<string>",
"transaction": "<unknown>",
"refund_items": [
{
"transaction_item_index_number": 123,
"sku": "<string>",
"description": "<string>",
"amount": 123,
"tax_only": true,
"taxes": [
{
"object": "<string>",
"jurisdiction": "<string>",
"name": "<string>",
"amount": 123,
"external_tax_name": "<string>",
"external_tax_category": "<string>",
"external_jurisdiction_name": "<string>",
"tax_rate": 123,
"external_tax_identifier": "<string>"
}
]
}
],
"refund_distribution_strategy": "None",
"amount": 123,
"amount_includes_tax": true,
"currency": "<string>",
"metadata": {},
"reference_string": "<string>",
"note": "<string>",
"token_action": "CancelNegativeBalance",
"credit": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"status": "Complete"
}
}
],
"discount": 123,
"subtotal": 123,
"total": 123
}
],
"affiliate": "<string>",
"sub_affiliate": "<string>",
"user_agent": "<string>",
"preferred_notification_language": "<string>",
"source_mac_address": "<string>",
"source_ip": "<string>",
"billing_descriptor": "<string>",
"sales_tax_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"verification_code": "<string>",
"subscription_sequence": 123,
"billing_plan_sequence": 123,
"mandate": {
"object": "Mandate",
"created": "<string>",
"identifier": "<string>",
"status": "Active"
},
"original_billing_date": "<string>",
"billing_attempt": 123,
"subscription": "<unknown>",
"score": 123,
"score_calculated": "<string>",
"score_calculated_orig": "<string>",
"score_codes": [
{
"object": "ScoreCode",
"id": "<string>",
"description": "<string>"
}
],
"distance_ip_ba": 123,
"avs_code": "<string>",
"cvn_code": "<string>",
"cvn_checked": true,
"policy": [
"<string>"
],
"to_be_captured": true
},
"metadata": {},
"credit": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"statement_format": "Attachment",
"invoice_terms": 123,
"statement_offset": 123,
"statement_template": "<string>",
"billing_plan_campaign_code": "<string>",
"billing_plan_campaign_id": "<string>",
"unkonwn_starts": true,
"balance": 123,
"mandate": {
"object": "Mandate",
"created": "<string>",
"identifier": "<string>",
"status": "Active"
},
"cancel_reason": {
"reason_code": "<string>",
"description": "<string>"
},
"policy": [
"<string>"
]
}
],
"url": "<string>",
"next": "<string>",
"previous": "<string>"
}{
"code": "invalid-request",
"message": "<string>",
"validationErrors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "authentication-required",
"message": "<string>"
}{
"code": "not-found",
"message": "<string>"
}{
"code": "input-conflict",
"message": "<string>"
}{
"code": "server-error",
"message": "<string>"
}Get Subscriptions
Retrieves a list of Subscriptions. This can be used to get a cross-account list of subscriptions, or for a given account using the “account” query parameter.
GET
/
submgmt
/
v2
/
subscriptions
Get Subscriptions
curl --request GET \
--url https://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions \
--header 'X-API-KEY: <api-key>'import requests
url = "https://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions', 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://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://int-prodtest.m1amdocs.io/submgmt/v2/subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"total_count": 123,
"data": [
{
"object": "Subscription",
"id": "<string>",
"account": {
"id": "<string>",
"object": "Account",
"vid": "<string>",
"external_id": "<string>",
"created": "<string>",
"parent": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"default_currency": "<string>",
"email": "<string>",
"email_type": "html",
"language": "<string>",
"notify_before_billing": true,
"company": "<string>",
"name": "<string>",
"shipping_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"payment_methods": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
}
]
},
"metadata": {},
"tax_exemptions": [
{
"object": "TaxExemption",
"region": "<string>",
"exemption_id": "<string>",
"active": true
}
],
"tokens": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"credit": [
{
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
}
],
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"tax_use_code": "<string>"
},
"status": "Pending Activation",
"items": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "SubscriptionItem",
"id": "<string>",
"product": {
"object": "Product",
"id": "<string>",
"descriptions": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "ProductDescription",
"language": "<string>",
"description": "<string>"
}
]
},
"status": "Active",
"vid": "<string>",
"created": "<string>",
"tax_classification": "<string>",
"br_tax_category": "Goods",
"default_billing_plan": {
"id": "<string>",
"vid": "<string>",
"object": "BillingPlan",
"created": "<string>",
"description": "<string>",
"status": "Active",
"tax_classification": "<string>",
"br_tax_category": "<string>",
"trial": {
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
},
"periods": [
{
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
}
],
"billing_notification_days": 123,
"trial_end_notification_days": 123,
"skip_initial_billing_notification": true,
"end_of_life": "<string>",
"metadata": {},
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"billing_descriptor": "<string>",
"times_to_run": "<string>",
"entitlements_valid_for": "<string>",
"repeat_every": "<string>",
"season_set": {
"id": "<string>",
"vid": "<string>",
"object": "SeasonSet",
"created": "<string>",
"seasons": [
{
"object": "Season",
"description": "<string>",
"starts": "<string>",
"ends": "<string>"
}
],
"metadata": {}
},
"days_before_season_to_bill": 123,
"days_entitled_before_season": 123,
"days_entitled_after_season": 123,
"entitled_off_season": true,
"used_on_subscriptions": true,
"grace_period_override": 123
},
"default_rate_plan": {
"object": "RatePlan",
"id": "<string>",
"vid": "<string>"
},
"end_of_life": "<string>",
"metadata": {},
"entitlements": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
]
},
"inherited_entitlements": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
]
},
"billing_descriptor": "<string>",
"credit_granted": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"prices": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "ProductPrice",
"amount": 123,
"currency": "<string>",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
}
}
]
},
"bundled_products": "<array>"
},
"vid": "<string>",
"index": 123,
"campaign_id": "<string>",
"amount": 123,
"currency": "<string>",
"rate_plan": {
"object": "RatePlan",
"id": "<string>",
"vid": "<string>"
},
"metadata": {},
"quantity": 123,
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"cycles": 123,
"cycles_remaining": 123,
"created": "<string>",
"ends": "<string>",
"starts": "<string>",
"discount_tickets": [
{}
],
"replaces": "<unknown>",
"replaced_by": "<unknown>"
}
]
},
"vid": "<string>",
"created": "<string>",
"billing_plan": {
"id": "<string>",
"vid": "<string>",
"object": "BillingPlan",
"created": "<string>",
"description": "<string>",
"status": "Active",
"tax_classification": "<string>",
"br_tax_category": "<string>",
"trial": {
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
},
"periods": [
{
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
}
],
"billing_notification_days": 123,
"trial_end_notification_days": 123,
"skip_initial_billing_notification": true,
"end_of_life": "<string>",
"metadata": {},
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"billing_descriptor": "<string>",
"times_to_run": "<string>",
"entitlements_valid_for": "<string>",
"repeat_every": "<string>",
"season_set": {
"id": "<string>",
"vid": "<string>",
"object": "SeasonSet",
"created": "<string>",
"seasons": [
{
"object": "Season",
"description": "<string>",
"starts": "<string>",
"ends": "<string>"
}
],
"metadata": {}
},
"days_before_season_to_bill": 123,
"days_entitled_before_season": 123,
"days_entitled_after_season": 123,
"entitled_off_season": true,
"used_on_subscriptions": true,
"grace_period_override": 123
},
"payment_method": {
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
},
"currency": "<string>",
"billing_state": "Free/Trial",
"starts": "<string>",
"ends": "<string>",
"entitled_through": "<string>",
"source_ip": "<string>",
"billing_descriptor": "<string>",
"billing_day": 123,
"minimum_commitment": 123,
"affiliate": "<string>",
"sub_affiliate": "<string>",
"notify_on_transition": true,
"most_recent_billing": {
"object": "Transaction",
"id": "<string>",
"vid": "<string>",
"created": "<string>",
"amount": 123,
"original_amount": 123,
"currency": "<string>",
"division_number": "<string>",
"previous_id": "<string>",
"account": {
"id": "<string>",
"object": "Account",
"vid": "<string>",
"external_id": "<string>",
"created": "<string>",
"parent": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"default_currency": "<string>",
"email": "<string>",
"email_type": "html",
"language": "<string>",
"notify_before_billing": true,
"company": "<string>",
"name": "<string>",
"shipping_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"payment_methods": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
}
]
},
"metadata": {},
"tax_exemptions": [
{
"object": "TaxExemption",
"region": "<string>",
"exemption_id": "<string>",
"active": true
}
],
"tokens": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"credit": [
{
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
}
],
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"tax_use_code": "<string>"
},
"source_payment_method": {
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
},
"dest_payment_method": {
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
},
"ecp_transaction_type": "All",
"status_log": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
}
]
},
"payment_processor": "<string>",
"payment_processor_transaction_id": "<string>",
"shipping_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"metadata": {},
"items": [
{
"object": "TransactionItem",
"sku": "<string>",
"index_number": 123,
"item_type": "<string>",
"name": "<string>",
"subscription_item": {
"object": "SubscriptionItem",
"id": "<string>",
"product": {
"object": "Product",
"id": "<string>",
"descriptions": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "ProductDescription",
"language": "<string>",
"description": "<string>"
}
]
},
"status": "Active",
"vid": "<string>",
"created": "<string>",
"tax_classification": "<string>",
"br_tax_category": "Goods",
"default_billing_plan": {
"id": "<string>",
"vid": "<string>",
"object": "BillingPlan",
"created": "<string>",
"description": "<string>",
"status": "Active",
"tax_classification": "<string>",
"br_tax_category": "<string>",
"trial": {
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
},
"periods": [
{
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
}
],
"billing_notification_days": 123,
"trial_end_notification_days": 123,
"skip_initial_billing_notification": true,
"end_of_life": "<string>",
"metadata": {},
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"billing_descriptor": "<string>",
"times_to_run": "<string>",
"entitlements_valid_for": "<string>",
"repeat_every": "<string>",
"season_set": {
"id": "<string>",
"vid": "<string>",
"object": "SeasonSet",
"created": "<string>",
"seasons": [
{
"object": "Season",
"description": "<string>",
"starts": "<string>",
"ends": "<string>"
}
],
"metadata": {}
},
"days_before_season_to_bill": 123,
"days_entitled_before_season": 123,
"days_entitled_after_season": 123,
"entitled_off_season": true,
"used_on_subscriptions": true,
"grace_period_override": 123
},
"default_rate_plan": {
"object": "RatePlan",
"id": "<string>",
"vid": "<string>"
},
"end_of_life": "<string>",
"metadata": {},
"entitlements": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
]
},
"inherited_entitlements": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
]
},
"billing_descriptor": "<string>",
"credit_granted": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"prices": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "ProductPrice",
"amount": 123,
"currency": "<string>",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
}
}
]
},
"bundled_products": "<array>"
},
"vid": "<string>",
"index": 123,
"campaign_id": "<string>",
"amount": 123,
"currency": "<string>",
"rate_plan": {
"object": "RatePlan",
"id": "<string>",
"vid": "<string>"
},
"metadata": {},
"quantity": 123,
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"cycles": 123,
"cycles_remaining": 123,
"created": "<string>",
"ends": "<string>",
"starts": "<string>",
"discount_tickets": [
{}
],
"replaces": "<unknown>",
"replaced_by": "<unknown>"
},
"price": 123,
"metadata": {},
"quantity": 123,
"tax_classification": "<string>",
"tokens": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"campaign_code": "<string>",
"campaign_id": "<string>",
"campaign_description": "<string>",
"service_period_starts": "<string>",
"service_period_ends": "<string>",
"tax_type": "<string>",
"tax": {
"object": "<string>",
"data": [
{
"object": "<string>",
"jurisdiction": "<string>",
"name": "<string>",
"amount": 123,
"external_tax_name": "<string>",
"external_tax_category": "<string>",
"external_jurisdiction_name": "<string>",
"tax_rate": 123,
"external_tax_identifier": "<string>"
}
],
"total_count": 123
},
"related_transactions": [
"<string>"
],
"item_refunds": [
{
"created": "<string>",
"amount": "<string>",
"tax": 123,
"tax_only": true,
"refund": {
"object": "Refund",
"id": "<string>",
"vid": "<string>",
"created": "<string>",
"transaction": "<unknown>",
"refund_items": [
{
"transaction_item_index_number": 123,
"sku": "<string>",
"description": "<string>",
"amount": 123,
"tax_only": true,
"taxes": [
{
"object": "<string>",
"jurisdiction": "<string>",
"name": "<string>",
"amount": 123,
"external_tax_name": "<string>",
"external_tax_category": "<string>",
"external_jurisdiction_name": "<string>",
"tax_rate": 123,
"external_tax_identifier": "<string>"
}
]
}
],
"refund_distribution_strategy": "None",
"amount": 123,
"amount_includes_tax": true,
"currency": "<string>",
"metadata": {},
"reference_string": "<string>",
"note": "<string>",
"token_action": "CancelNegativeBalance",
"credit": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"status": "Complete"
}
}
],
"discount": 123,
"subtotal": 123,
"total": 123
}
],
"affiliate": "<string>",
"sub_affiliate": "<string>",
"user_agent": "<string>",
"preferred_notification_language": "<string>",
"source_mac_address": "<string>",
"source_ip": "<string>",
"billing_descriptor": "<string>",
"sales_tax_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"verification_code": "<string>",
"subscription_sequence": 123,
"billing_plan_sequence": 123,
"mandate": {
"object": "Mandate",
"created": "<string>",
"identifier": "<string>",
"status": "Active"
},
"original_billing_date": "<string>",
"billing_attempt": 123,
"subscription": "<unknown>",
"score": 123,
"score_calculated": "<string>",
"score_calculated_orig": "<string>",
"score_codes": [
{
"object": "ScoreCode",
"id": "<string>",
"description": "<string>"
}
],
"distance_ip_ba": 123,
"avs_code": "<string>",
"cvn_code": "<string>",
"cvn_checked": true,
"policy": [
"<string>"
],
"to_be_captured": true
},
"most_recent_refunds": [
{
"object": "Refund",
"id": "<string>",
"vid": "<string>",
"created": "<string>",
"transaction": "<unknown>",
"refund_items": [
{
"transaction_item_index_number": 123,
"sku": "<string>",
"description": "<string>",
"amount": 123,
"tax_only": true,
"taxes": [
{
"object": "<string>",
"jurisdiction": "<string>",
"name": "<string>",
"amount": 123,
"external_tax_name": "<string>",
"external_tax_category": "<string>",
"external_jurisdiction_name": "<string>",
"tax_rate": 123,
"external_tax_identifier": "<string>"
}
]
}
],
"refund_distribution_strategy": "None",
"amount": 123,
"amount_includes_tax": true,
"currency": "<string>",
"metadata": {},
"reference_string": "<string>",
"note": "<string>",
"token_action": "CancelNegativeBalance",
"credit": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"status": "Complete"
}
],
"next_billing": {
"object": "Transaction",
"id": "<string>",
"vid": "<string>",
"created": "<string>",
"amount": 123,
"original_amount": 123,
"currency": "<string>",
"division_number": "<string>",
"previous_id": "<string>",
"account": {
"id": "<string>",
"object": "Account",
"vid": "<string>",
"external_id": "<string>",
"created": "<string>",
"parent": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"default_currency": "<string>",
"email": "<string>",
"email_type": "html",
"language": "<string>",
"notify_before_billing": true,
"company": "<string>",
"name": "<string>",
"shipping_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"payment_methods": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
}
]
},
"metadata": {},
"tax_exemptions": [
{
"object": "TaxExemption",
"region": "<string>",
"exemption_id": "<string>",
"active": true
}
],
"tokens": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"credit": [
{
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
}
],
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"tax_use_code": "<string>"
},
"source_payment_method": {
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
},
"dest_payment_method": {
"id": "<string>",
"vid": "<string>",
"object": "PaymentMethod",
"created": "<string>",
"type": "Amazon",
"credit_card": {
"vid": "<string>",
"object": "CreditCard",
"last_digits": "<string>",
"account_length": 123,
"hash_type": "sha1",
"expiration_date": "<string>",
"extended_card_attributes": {},
"cvn": "<string>",
"last_au_request_date": "<string>",
"last_update_date": "<string>",
"au_response_code": "<string>",
"au_response_message": "<string>"
},
"direct_debit": {},
"paypal": {},
"amazon": {},
"merchant_accepted_payment": {
"object": "MerchantAcceptedPayment",
"amount": 123,
"currency": "<string>",
"created": "<string>",
"payment_type": "<string>",
"account": "<string>",
"last_digits": "<string>"
},
"external_billing": {
"object": "ExternalBilling",
"bill_receiver": "<string>",
"payment_channel": "<string>",
"financial_account": "<string>"
},
"carrier_billing": {
"object": "CarrierBilling",
"phone_number": {
"object": "PhoneNumber",
"phone_type": "CS",
"country_code": "<string>",
"area_code": "<string>",
"local_number": "<string>",
"extension": "<string>",
"raw_input": "<string>"
},
"encoded_phone_number": "<string>",
"carrier": "<string>",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_criteria": {
"object": "PriceCriteria",
"payment_provider": {
"object": "PaymentProvider",
"name": "<string>",
"dispute_address": "<string>",
"dispute_email": "<string>",
"dispute_uri": "<string>",
"auth_expiration_days": 123,
"auth_currency_override": "<string>",
"metadata": {}
},
"currency": "<string>",
"country_code": "<string>",
"price_point_deviation_policy": "HiOnly",
"dynamic_price_mode": "PayoutGross",
"merchant_service_identifier": "<string>",
"sub_merchant_identifier": "<string>",
"description": "<string>",
"fwd_url": "<string>",
"static_selection_row_ref": 123,
"static_price_inc_sales_tax": "<string>",
"dynamic_deviation": 123,
"dynamic_match": 123,
"dynamic_target_price": "<string>"
},
"account_identifier": "<string>",
"carrier_billing_account_identifier_type": "MSISDN",
"customer_identifier": "not yet available - see VIN-26551",
"customer_identifier_type": "PoS , Web",
"validated": "<string>"
},
"apple_pay": {},
"google_pay": {},
"metadata": {},
"account_holder": "<string>",
"billing_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"customer_specified_type": "<string>",
"customer_description": "<string>",
"currency": "<string>",
"primary": true,
"active": true,
"validation_status": {
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
},
"policy": {}
},
"ecp_transaction_type": "All",
"status_log": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "TransactionStatus",
"status": "New",
"created": "<string>",
"payment_method_type": "CreditCard",
"vin_avs": "FullMatch",
"funding_source_balance": 123
}
]
},
"payment_processor": "<string>",
"payment_processor_transaction_id": "<string>",
"shipping_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"metadata": {},
"items": [
{
"object": "TransactionItem",
"sku": "<string>",
"index_number": 123,
"item_type": "<string>",
"name": "<string>",
"subscription_item": {
"object": "SubscriptionItem",
"id": "<string>",
"product": {
"object": "Product",
"id": "<string>",
"descriptions": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "ProductDescription",
"language": "<string>",
"description": "<string>"
}
]
},
"status": "Active",
"vid": "<string>",
"created": "<string>",
"tax_classification": "<string>",
"br_tax_category": "Goods",
"default_billing_plan": {
"id": "<string>",
"vid": "<string>",
"object": "BillingPlan",
"created": "<string>",
"description": "<string>",
"status": "Active",
"tax_classification": "<string>",
"br_tax_category": "<string>",
"trial": {
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
},
"periods": [
{
"object": "BillingPlanPeriod",
"type": "Day",
"quantity": 123,
"cycles": 123,
"prices": [
{
"object": "<string>",
"amount": 123,
"currency": "<string>",
"price_list_name": "<string>",
"token_amount": {
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
}
]
}
],
"billing_notification_days": 123,
"trial_end_notification_days": 123,
"skip_initial_billing_notification": true,
"end_of_life": "<string>",
"metadata": {},
"entitlements": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
],
"billing_descriptor": "<string>",
"times_to_run": "<string>",
"entitlements_valid_for": "<string>",
"repeat_every": "<string>",
"season_set": {
"id": "<string>",
"vid": "<string>",
"object": "SeasonSet",
"created": "<string>",
"seasons": [
{
"object": "Season",
"description": "<string>",
"starts": "<string>",
"ends": "<string>"
}
],
"metadata": {}
},
"days_before_season_to_bill": 123,
"days_entitled_before_season": 123,
"days_entitled_after_season": 123,
"entitled_off_season": true,
"used_on_subscriptions": true,
"grace_period_override": 123
},
"default_rate_plan": {
"object": "RatePlan",
"id": "<string>",
"vid": "<string>"
},
"end_of_life": "<string>",
"metadata": {},
"entitlements": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
]
},
"inherited_entitlements": {
"object": "List",
"total_count": 123,
"data": [
{
"id": "<string>",
"object": "Entitlement",
"description": "<string>"
}
]
},
"billing_descriptor": "<string>",
"credit_granted": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"prices": {
"object": "List",
"total_count": 123,
"data": [
{
"object": "ProductPrice",
"amount": 123,
"currency": "<string>",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
}
}
]
},
"bundled_products": "<array>"
},
"vid": "<string>",
"index": 123,
"campaign_id": "<string>",
"amount": 123,
"currency": "<string>",
"rate_plan": {
"object": "RatePlan",
"id": "<string>",
"vid": "<string>"
},
"metadata": {},
"quantity": 123,
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"cycles": 123,
"cycles_remaining": 123,
"created": "<string>",
"ends": "<string>",
"starts": "<string>",
"discount_tickets": [
{}
],
"replaces": "<unknown>",
"replaced_by": "<unknown>"
},
"price": 123,
"metadata": {},
"quantity": 123,
"tax_classification": "<string>",
"tokens": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"campaign_code": "<string>",
"campaign_id": "<string>",
"campaign_description": "<string>",
"service_period_starts": "<string>",
"service_period_ends": "<string>",
"tax_type": "<string>",
"tax": {
"object": "<string>",
"data": [
{
"object": "<string>",
"jurisdiction": "<string>",
"name": "<string>",
"amount": 123,
"external_tax_name": "<string>",
"external_tax_category": "<string>",
"external_jurisdiction_name": "<string>",
"tax_rate": 123,
"external_tax_identifier": "<string>"
}
],
"total_count": 123
},
"related_transactions": [
"<string>"
],
"item_refunds": [
{
"created": "<string>",
"amount": "<string>",
"tax": 123,
"tax_only": true,
"refund": {
"object": "Refund",
"id": "<string>",
"vid": "<string>",
"created": "<string>",
"transaction": "<unknown>",
"refund_items": [
{
"transaction_item_index_number": 123,
"sku": "<string>",
"description": "<string>",
"amount": 123,
"tax_only": true,
"taxes": [
{
"object": "<string>",
"jurisdiction": "<string>",
"name": "<string>",
"amount": 123,
"external_tax_name": "<string>",
"external_tax_category": "<string>",
"external_jurisdiction_name": "<string>",
"tax_rate": 123,
"external_tax_identifier": "<string>"
}
]
}
],
"refund_distribution_strategy": "None",
"amount": 123,
"amount_includes_tax": true,
"currency": "<string>",
"metadata": {},
"reference_string": "<string>",
"note": "<string>",
"token_action": "CancelNegativeBalance",
"credit": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"status": "Complete"
}
}
],
"discount": 123,
"subtotal": 123,
"total": 123
}
],
"affiliate": "<string>",
"sub_affiliate": "<string>",
"user_agent": "<string>",
"preferred_notification_language": "<string>",
"source_mac_address": "<string>",
"source_ip": "<string>",
"billing_descriptor": "<string>",
"sales_tax_address": {
"object": "Address",
"vid": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"county": "<string>",
"district": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"fax": "<string>",
"latitude": 123,
"longitude": 123,
"tax_area_identifier": 123
},
"verification_code": "<string>",
"subscription_sequence": 123,
"billing_plan_sequence": 123,
"mandate": {
"object": "Mandate",
"created": "<string>",
"identifier": "<string>",
"status": "Active"
},
"original_billing_date": "<string>",
"billing_attempt": 123,
"subscription": "<unknown>",
"score": 123,
"score_calculated": "<string>",
"score_calculated_orig": "<string>",
"score_codes": [
{
"object": "ScoreCode",
"id": "<string>",
"description": "<string>"
}
],
"distance_ip_ba": 123,
"avs_code": "<string>",
"cvn_code": "<string>",
"cvn_checked": true,
"policy": [
"<string>"
],
"to_be_captured": true
},
"metadata": {},
"credit": {
"object": "Credit",
"token_amounts": [
{
"object": "TokenAmount",
"token": {
"object": "Token",
"id": "<string>",
"vid": "<string>",
"description": "<string>"
},
"amount": 123,
"source": "<string>"
}
],
"currency_amounts": [
{
"object": "CurrencyAmount",
"vid": "<string>",
"currency": "<string>",
"amount": 123,
"metadata": {},
"sort_value": 123,
"description": "<string>",
"reason": "<string>",
"granted_by_cashbox": true,
"granted": "<string>",
"account": {
"object": "Account",
"id": "<string>",
"vid": "<string>"
},
"subscription": {
"object": "Subscription",
"id": "<string>",
"vid": "<string>"
}
}
]
},
"statement_format": "Attachment",
"invoice_terms": 123,
"statement_offset": 123,
"statement_template": "<string>",
"billing_plan_campaign_code": "<string>",
"billing_plan_campaign_id": "<string>",
"unkonwn_starts": true,
"balance": 123,
"mandate": {
"object": "Mandate",
"created": "<string>",
"identifier": "<string>",
"status": "Active"
},
"cancel_reason": {
"reason_code": "<string>",
"description": "<string>"
},
"policy": [
"<string>"
]
}
],
"url": "<string>",
"next": "<string>",
"previous": "<string>"
}{
"code": "invalid-request",
"message": "<string>",
"validationErrors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "authentication-required",
"message": "<string>"
}{
"code": "not-found",
"message": "<string>"
}{
"code": "input-conflict",
"message": "<string>"
}{
"code": "server-error",
"message": "<string>"
}Authorizations
The authorization key obtained from MarketONE.
Headers
The TraceId indicates the overall ID of the trace. Every span in a trace shares this ID. The X-B3-TraceId header is encoded as 32 or 16 lower-hex characters. For example, a 128-bit TraceId header might look like 463ac35c9f6413ad48485a3953bb6124.
The SpanId is 64-bit in length and indicates the position of the current operation in the trace tree. The value should not be interpreted; it may or may not be derived from the value of the TraceId. The X-B3-SpanId header is encoded as 16 lower-hex characters. For example, a SpanId header might look like a2fb4a1d1a96d312. Unless propagating only the Sampling State, the X-B3-SpanId header is required.
The ParentSpanId is 64-bit in length and indicates the position of the parent operation in the trace tree. When the span is the root of the trace tree, there is no ParentSpanId. The X-B3-ParentSpanId header may be present on a child span and must be absent on the root span. It is encoded as 16 lower-hex characters. For example, a ParentSpanId header might look like 0020000000000001.
Query Parameters
A limit on the number of objects to be returned, between 1 and 100.
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
Limit the subscription list to a specified account id or vid - if specified, all Subscriptions associated with that Account.
Indicates whether or not to return any existing child accounts’ subscriptions for a given returned Subscription/account combination.
Limit the Subscription list to those associated with a specific email.
Limit the Subscription list to those that have a specified product id or vid as a SubscriptionItem.
Describe the all billing plan history of the subscriptions
Response
OK
Integer count of the number of items in the returned list.
Show child attributes
Show child attributes
The query string provided in the request
The route (partial URL) to the next Subscription object (string to select the “next”); included id should match that of the last object returned here
The route (partial URL) to the previous Subscriptions object (string to select the “previous”); included id should match that of the first object returned here
Was this page helpful?