Update a specific Billing Plan.
curl --request POST \
--url https://int-prodtest.m1amdocs.io/slmgw/v1/billing_plans/{id} \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"vid": "<string>",
"object": "BillingPlan",
"created": "<string>",
"description": "<string>",
"tax_classification": "<string>",
"br_tax_category": "<string>",
"trial": {
"object": "BillingPlanPeriod",
"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",
"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
}
'import requests
url = "https://int-prodtest.m1amdocs.io/slmgw/v1/billing_plans/{id}"
payload = {
"id": "<string>",
"vid": "<string>",
"object": "BillingPlan",
"created": "<string>",
"description": "<string>",
"tax_classification": "<string>",
"br_tax_category": "<string>",
"trial": {
"object": "BillingPlanPeriod",
"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",
"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
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
vid: '<string>',
object: 'BillingPlan',
created: '<string>',
description: '<string>',
tax_classification: '<string>',
br_tax_category: '<string>',
trial: {
object: 'BillingPlanPeriod',
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',
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
})
};
fetch('https://int-prodtest.m1amdocs.io/slmgw/v1/billing_plans/{id}', 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/slmgw/v1/billing_plans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'vid' => '<string>',
'object' => 'BillingPlan',
'created' => '<string>',
'description' => '<string>',
'tax_classification' => '<string>',
'br_tax_category' => '<string>',
'trial' => [
'object' => 'BillingPlanPeriod',
'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',
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://int-prodtest.m1amdocs.io/slmgw/v1/billing_plans/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"object\": \"BillingPlan\",\n \"created\": \"<string>\",\n \"description\": \"<string>\",\n \"tax_classification\": \"<string>\",\n \"br_tax_category\": \"<string>\",\n \"trial\": {\n \"object\": \"BillingPlanPeriod\",\n \"quantity\": 123,\n \"cycles\": 123,\n \"prices\": [\n {\n \"object\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"price_list_name\": \"<string>\",\n \"token_amount\": {\n \"object\": \"TokenAmount\",\n \"token\": {\n \"object\": \"Token\",\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"amount\": 123,\n \"source\": \"<string>\"\n }\n }\n ]\n },\n \"periods\": [\n {\n \"object\": \"BillingPlanPeriod\",\n \"quantity\": 123,\n \"cycles\": 123,\n \"prices\": [\n {\n \"object\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"price_list_name\": \"<string>\",\n \"token_amount\": {\n \"object\": \"TokenAmount\",\n \"token\": {\n \"object\": \"Token\",\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"amount\": 123,\n \"source\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"billing_notification_days\": 123,\n \"trial_end_notification_days\": 123,\n \"skip_initial_billing_notification\": true,\n \"end_of_life\": \"<string>\",\n \"metadata\": {},\n \"entitlements\": [\n {\n \"id\": \"<string>\",\n \"object\": \"Entitlement\",\n \"description\": \"<string>\"\n }\n ],\n \"billing_descriptor\": \"<string>\",\n \"times_to_run\": \"<string>\",\n \"entitlements_valid_for\": \"<string>\",\n \"repeat_every\": \"<string>\",\n \"season_set\": {\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"object\": \"SeasonSet\",\n \"created\": \"<string>\",\n \"seasons\": [\n {\n \"object\": \"Season\",\n \"description\": \"<string>\",\n \"starts\": \"<string>\",\n \"ends\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"days_before_season_to_bill\": 123,\n \"days_entitled_before_season\": 123,\n \"days_entitled_after_season\": 123,\n \"entitled_off_season\": true,\n \"used_on_subscriptions\": true,\n \"grace_period_override\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://int-prodtest.m1amdocs.io/slmgw/v1/billing_plans/{id}")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"object\": \"BillingPlan\",\n \"created\": \"<string>\",\n \"description\": \"<string>\",\n \"tax_classification\": \"<string>\",\n \"br_tax_category\": \"<string>\",\n \"trial\": {\n \"object\": \"BillingPlanPeriod\",\n \"quantity\": 123,\n \"cycles\": 123,\n \"prices\": [\n {\n \"object\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"price_list_name\": \"<string>\",\n \"token_amount\": {\n \"object\": \"TokenAmount\",\n \"token\": {\n \"object\": \"Token\",\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"amount\": 123,\n \"source\": \"<string>\"\n }\n }\n ]\n },\n \"periods\": [\n {\n \"object\": \"BillingPlanPeriod\",\n \"quantity\": 123,\n \"cycles\": 123,\n \"prices\": [\n {\n \"object\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"price_list_name\": \"<string>\",\n \"token_amount\": {\n \"object\": \"TokenAmount\",\n \"token\": {\n \"object\": \"Token\",\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"amount\": 123,\n \"source\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"billing_notification_days\": 123,\n \"trial_end_notification_days\": 123,\n \"skip_initial_billing_notification\": true,\n \"end_of_life\": \"<string>\",\n \"metadata\": {},\n \"entitlements\": [\n {\n \"id\": \"<string>\",\n \"object\": \"Entitlement\",\n \"description\": \"<string>\"\n }\n ],\n \"billing_descriptor\": \"<string>\",\n \"times_to_run\": \"<string>\",\n \"entitlements_valid_for\": \"<string>\",\n \"repeat_every\": \"<string>\",\n \"season_set\": {\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"object\": \"SeasonSet\",\n \"created\": \"<string>\",\n \"seasons\": [\n {\n \"object\": \"Season\",\n \"description\": \"<string>\",\n \"starts\": \"<string>\",\n \"ends\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"days_before_season_to_bill\": 123,\n \"days_entitled_before_season\": 123,\n \"days_entitled_after_season\": 123,\n \"entitled_off_season\": true,\n \"used_on_subscriptions\": true,\n \"grace_period_override\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://int-prodtest.m1amdocs.io/slmgw/v1/billing_plans/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"object\": \"BillingPlan\",\n \"created\": \"<string>\",\n \"description\": \"<string>\",\n \"tax_classification\": \"<string>\",\n \"br_tax_category\": \"<string>\",\n \"trial\": {\n \"object\": \"BillingPlanPeriod\",\n \"quantity\": 123,\n \"cycles\": 123,\n \"prices\": [\n {\n \"object\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"price_list_name\": \"<string>\",\n \"token_amount\": {\n \"object\": \"TokenAmount\",\n \"token\": {\n \"object\": \"Token\",\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"amount\": 123,\n \"source\": \"<string>\"\n }\n }\n ]\n },\n \"periods\": [\n {\n \"object\": \"BillingPlanPeriod\",\n \"quantity\": 123,\n \"cycles\": 123,\n \"prices\": [\n {\n \"object\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"price_list_name\": \"<string>\",\n \"token_amount\": {\n \"object\": \"TokenAmount\",\n \"token\": {\n \"object\": \"Token\",\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"amount\": 123,\n \"source\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"billing_notification_days\": 123,\n \"trial_end_notification_days\": 123,\n \"skip_initial_billing_notification\": true,\n \"end_of_life\": \"<string>\",\n \"metadata\": {},\n \"entitlements\": [\n {\n \"id\": \"<string>\",\n \"object\": \"Entitlement\",\n \"description\": \"<string>\"\n }\n ],\n \"billing_descriptor\": \"<string>\",\n \"times_to_run\": \"<string>\",\n \"entitlements_valid_for\": \"<string>\",\n \"repeat_every\": \"<string>\",\n \"season_set\": {\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"object\": \"SeasonSet\",\n \"created\": \"<string>\",\n \"seasons\": [\n {\n \"object\": \"Season\",\n \"description\": \"<string>\",\n \"starts\": \"<string>\",\n \"ends\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"days_before_season_to_bill\": 123,\n \"days_entitled_before_season\": 123,\n \"days_entitled_after_season\": 123,\n \"entitled_off_season\": true,\n \"used_on_subscriptions\": true,\n \"grace_period_override\": 123\n}"
response = http.request(request)
puts response.read_body{
"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
}{
"code": "invalid-request",
"message": "<string>",
"validationErrors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "authentication-required",
"message": "<string>"
}{
"code": "not-found",
"message": "<string>"
}{
"code": "server-error",
"message": "<string>"
}Update a specific Billing Plan.
POST
/
slmgw
/
v1
/
billing_plans
/
{id}
Update a specific Billing Plan.
curl --request POST \
--url https://int-prodtest.m1amdocs.io/slmgw/v1/billing_plans/{id} \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"vid": "<string>",
"object": "BillingPlan",
"created": "<string>",
"description": "<string>",
"tax_classification": "<string>",
"br_tax_category": "<string>",
"trial": {
"object": "BillingPlanPeriod",
"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",
"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
}
'import requests
url = "https://int-prodtest.m1amdocs.io/slmgw/v1/billing_plans/{id}"
payload = {
"id": "<string>",
"vid": "<string>",
"object": "BillingPlan",
"created": "<string>",
"description": "<string>",
"tax_classification": "<string>",
"br_tax_category": "<string>",
"trial": {
"object": "BillingPlanPeriod",
"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",
"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
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
vid: '<string>',
object: 'BillingPlan',
created: '<string>',
description: '<string>',
tax_classification: '<string>',
br_tax_category: '<string>',
trial: {
object: 'BillingPlanPeriod',
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',
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
})
};
fetch('https://int-prodtest.m1amdocs.io/slmgw/v1/billing_plans/{id}', 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/slmgw/v1/billing_plans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'vid' => '<string>',
'object' => 'BillingPlan',
'created' => '<string>',
'description' => '<string>',
'tax_classification' => '<string>',
'br_tax_category' => '<string>',
'trial' => [
'object' => 'BillingPlanPeriod',
'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',
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://int-prodtest.m1amdocs.io/slmgw/v1/billing_plans/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"object\": \"BillingPlan\",\n \"created\": \"<string>\",\n \"description\": \"<string>\",\n \"tax_classification\": \"<string>\",\n \"br_tax_category\": \"<string>\",\n \"trial\": {\n \"object\": \"BillingPlanPeriod\",\n \"quantity\": 123,\n \"cycles\": 123,\n \"prices\": [\n {\n \"object\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"price_list_name\": \"<string>\",\n \"token_amount\": {\n \"object\": \"TokenAmount\",\n \"token\": {\n \"object\": \"Token\",\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"amount\": 123,\n \"source\": \"<string>\"\n }\n }\n ]\n },\n \"periods\": [\n {\n \"object\": \"BillingPlanPeriod\",\n \"quantity\": 123,\n \"cycles\": 123,\n \"prices\": [\n {\n \"object\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"price_list_name\": \"<string>\",\n \"token_amount\": {\n \"object\": \"TokenAmount\",\n \"token\": {\n \"object\": \"Token\",\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"amount\": 123,\n \"source\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"billing_notification_days\": 123,\n \"trial_end_notification_days\": 123,\n \"skip_initial_billing_notification\": true,\n \"end_of_life\": \"<string>\",\n \"metadata\": {},\n \"entitlements\": [\n {\n \"id\": \"<string>\",\n \"object\": \"Entitlement\",\n \"description\": \"<string>\"\n }\n ],\n \"billing_descriptor\": \"<string>\",\n \"times_to_run\": \"<string>\",\n \"entitlements_valid_for\": \"<string>\",\n \"repeat_every\": \"<string>\",\n \"season_set\": {\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"object\": \"SeasonSet\",\n \"created\": \"<string>\",\n \"seasons\": [\n {\n \"object\": \"Season\",\n \"description\": \"<string>\",\n \"starts\": \"<string>\",\n \"ends\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"days_before_season_to_bill\": 123,\n \"days_entitled_before_season\": 123,\n \"days_entitled_after_season\": 123,\n \"entitled_off_season\": true,\n \"used_on_subscriptions\": true,\n \"grace_period_override\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://int-prodtest.m1amdocs.io/slmgw/v1/billing_plans/{id}")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"object\": \"BillingPlan\",\n \"created\": \"<string>\",\n \"description\": \"<string>\",\n \"tax_classification\": \"<string>\",\n \"br_tax_category\": \"<string>\",\n \"trial\": {\n \"object\": \"BillingPlanPeriod\",\n \"quantity\": 123,\n \"cycles\": 123,\n \"prices\": [\n {\n \"object\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"price_list_name\": \"<string>\",\n \"token_amount\": {\n \"object\": \"TokenAmount\",\n \"token\": {\n \"object\": \"Token\",\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"amount\": 123,\n \"source\": \"<string>\"\n }\n }\n ]\n },\n \"periods\": [\n {\n \"object\": \"BillingPlanPeriod\",\n \"quantity\": 123,\n \"cycles\": 123,\n \"prices\": [\n {\n \"object\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"price_list_name\": \"<string>\",\n \"token_amount\": {\n \"object\": \"TokenAmount\",\n \"token\": {\n \"object\": \"Token\",\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"amount\": 123,\n \"source\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"billing_notification_days\": 123,\n \"trial_end_notification_days\": 123,\n \"skip_initial_billing_notification\": true,\n \"end_of_life\": \"<string>\",\n \"metadata\": {},\n \"entitlements\": [\n {\n \"id\": \"<string>\",\n \"object\": \"Entitlement\",\n \"description\": \"<string>\"\n }\n ],\n \"billing_descriptor\": \"<string>\",\n \"times_to_run\": \"<string>\",\n \"entitlements_valid_for\": \"<string>\",\n \"repeat_every\": \"<string>\",\n \"season_set\": {\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"object\": \"SeasonSet\",\n \"created\": \"<string>\",\n \"seasons\": [\n {\n \"object\": \"Season\",\n \"description\": \"<string>\",\n \"starts\": \"<string>\",\n \"ends\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"days_before_season_to_bill\": 123,\n \"days_entitled_before_season\": 123,\n \"days_entitled_after_season\": 123,\n \"entitled_off_season\": true,\n \"used_on_subscriptions\": true,\n \"grace_period_override\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://int-prodtest.m1amdocs.io/slmgw/v1/billing_plans/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"object\": \"BillingPlan\",\n \"created\": \"<string>\",\n \"description\": \"<string>\",\n \"tax_classification\": \"<string>\",\n \"br_tax_category\": \"<string>\",\n \"trial\": {\n \"object\": \"BillingPlanPeriod\",\n \"quantity\": 123,\n \"cycles\": 123,\n \"prices\": [\n {\n \"object\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"price_list_name\": \"<string>\",\n \"token_amount\": {\n \"object\": \"TokenAmount\",\n \"token\": {\n \"object\": \"Token\",\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"amount\": 123,\n \"source\": \"<string>\"\n }\n }\n ]\n },\n \"periods\": [\n {\n \"object\": \"BillingPlanPeriod\",\n \"quantity\": 123,\n \"cycles\": 123,\n \"prices\": [\n {\n \"object\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"price_list_name\": \"<string>\",\n \"token_amount\": {\n \"object\": \"TokenAmount\",\n \"token\": {\n \"object\": \"Token\",\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"amount\": 123,\n \"source\": \"<string>\"\n }\n }\n ]\n }\n ],\n \"billing_notification_days\": 123,\n \"trial_end_notification_days\": 123,\n \"skip_initial_billing_notification\": true,\n \"end_of_life\": \"<string>\",\n \"metadata\": {},\n \"entitlements\": [\n {\n \"id\": \"<string>\",\n \"object\": \"Entitlement\",\n \"description\": \"<string>\"\n }\n ],\n \"billing_descriptor\": \"<string>\",\n \"times_to_run\": \"<string>\",\n \"entitlements_valid_for\": \"<string>\",\n \"repeat_every\": \"<string>\",\n \"season_set\": {\n \"id\": \"<string>\",\n \"vid\": \"<string>\",\n \"object\": \"SeasonSet\",\n \"created\": \"<string>\",\n \"seasons\": [\n {\n \"object\": \"Season\",\n \"description\": \"<string>\",\n \"starts\": \"<string>\",\n \"ends\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"days_before_season_to_bill\": 123,\n \"days_entitled_before_season\": 123,\n \"days_entitled_after_season\": 123,\n \"entitled_off_season\": true,\n \"used_on_subscriptions\": true,\n \"grace_period_override\": 123\n}"
response = http.request(request)
puts response.read_body{
"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
}{
"code": "invalid-request",
"message": "<string>",
"validationErrors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "authentication-required",
"message": "<string>"
}{
"code": "not-found",
"message": "<string>"
}{
"code": "server-error",
"message": "<string>"
}Path Parameters
The id or the vid of the Product to retrieve.
Body
application/json
JSON A full Time Interval object.
A unique identifier.
Maximum string length:
128A Globally Unique Identifier (GUID) for this object. This value is generated by MarketONE.
Maximum string length:
128Value is “BillingPlan”
Available options:
BillingPlan The date and time the plan was created.
An aggregator-specified description of this offering.
aggregators may define whether they want to declare a plan as available to offer. Values can be Active,Suspended
Available options:
Active, Suspended The tax classification or code to be used with any plan-level charges.
enum(Category)
Optionally declares an initial trial period for this plan.
Show child attributes
Show child attributes
Defines the sequential billing periods in the plan, each with its own billing schedule and terms.
Show child attributes
Show child attributes
Number of days prior to schedule billing at which CashBox will send email notification.
For the trial period, this replaces billing_notification_days, indicating the number of days prior to end of a trial to send the trial end email.
Determines whether to send a billing notification for the initial period.
The date after which the plan should not be offered.
A set of key/value pairs that you can attach to an object. Useful for storing additional information.
Show child attributes
Show child attributes
Entitlements granted by active subscriptions on this plan.
Show child attributes
Show child attributes
Optional “soft descriptor” to send to the payment processor for transactions associated with a subscription using this billing plan.
The number of times the sequence of Billing Periods should be repeated. Valid input includes positive integers (Default is null).
The length of time for which Entitlements are valid after the last Billing date (Default is null).
If a Billing Period set repeats, this value defines the length of time after the first billing that the set should repeat.
The SeasonSet to which the Billing Plan applies. (May be null.)
Show child attributes
Show child attributes
Optional setting when using a season set to control the integer number of days before a season starts to bill.
Optional setting when using a season set to control the integer number of days customer is entitled before a season starts
Optional setting when using a season set to control the integer number of days after a season ends a customer remains entitled.
Optional setting when using a season set to continue entitling customer between seasons.
Signifies if Billing Plan has been used on an Active Subscription
Number of days after the billing date when, if payment is not received, the Subscription is stopped and the customer is disentitled; overrides the global aggregator default setting, if both are set.
Response
JSON A full BillingPlan object.
A unique identifier.
Maximum string length:
128A Globally Unique Identifier (GUID) for this object. This value is generated by MarketONE.
Maximum string length:
128Value is “BillingPlan”
Available options:
BillingPlan The date and time the plan was created.
An aggregator-specified description of this offering.
aggregators may define whether they want to declare a plan as available to offer. Values can be Active,Suspended
Available options:
Active, Suspended The tax classification or code to be used with any plan-level charges.
enum(Category)
Optionally declares an initial trial period for this plan.
Show child attributes
Show child attributes
Defines the sequential billing periods in the plan, each with its own billing schedule and terms.
Show child attributes
Show child attributes
Number of days prior to schedule billing at which CashBox will send email notification.
For the trial period, this replaces billing_notification_days, indicating the number of days prior to end of a trial to send the trial end email.
Determines whether to send a billing notification for the initial period.
The date after which the plan should not be offered.
A set of key/value pairs that you can attach to an object. Useful for storing additional information.
Show child attributes
Show child attributes
Entitlements granted by active subscriptions on this plan.
Show child attributes
Show child attributes
Optional “soft descriptor” to send to the payment processor for transactions associated with a subscription using this billing plan.
The number of times the sequence of Billing Periods should be repeated. Valid input includes positive integers (Default is null).
The length of time for which Entitlements are valid after the last Billing date (Default is null).
If a Billing Period set repeats, this value defines the length of time after the first billing that the set should repeat.
The SeasonSet to which the Billing Plan applies. (May be null.)
Show child attributes
Show child attributes
Optional setting when using a season set to control the integer number of days before a season starts to bill.
Optional setting when using a season set to control the integer number of days customer is entitled before a season starts
Optional setting when using a season set to control the integer number of days after a season ends a customer remains entitled.
Optional setting when using a season set to continue entitling customer between seasons.
Signifies if Billing Plan has been used on an Active Subscription
Number of days after the billing date when, if payment is not received, the Subscription is stopped and the customer is disentitled; overrides the global aggregator default setting, if both are set.
Was this page helpful?