Update subscription
curl --request PUT \
--url https://api.example.com/subscriptions/{subscriptionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-environment: <x-environment>' \
--data '
{
"start": "2023-12-25",
"end": "2023-12-25",
"autoRenewal": true,
"description": "<string>",
"items": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"billAt": "2023-11-07T05:31:56Z",
"periodFrom": "2023-12-25",
"prorate": {
"fromDate": "2023-12-25"
}
}
]
}
'import requests
url = "https://api.example.com/subscriptions/{subscriptionId}"
payload = {
"start": "2023-12-25",
"end": "2023-12-25",
"autoRenewal": True,
"description": "<string>",
"items": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"billAt": "2023-11-07T05:31:56Z",
"periodFrom": "2023-12-25",
"prorate": { "fromDate": "2023-12-25" }
}
]
}
headers = {
"x-environment": "<x-environment>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-environment': '<x-environment>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
start: '2023-12-25',
end: '2023-12-25',
autoRenewal: true,
description: '<string>',
items: [
{
productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
priceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 123,
billAt: '2023-11-07T05:31:56Z',
periodFrom: '2023-12-25',
prorate: {fromDate: '2023-12-25'}
}
]
})
};
fetch('https://api.example.com/subscriptions/{subscriptionId}', 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://api.example.com/subscriptions/{subscriptionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'start' => '2023-12-25',
'end' => '2023-12-25',
'autoRenewal' => true,
'description' => '<string>',
'items' => [
[
'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'priceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 123,
'billAt' => '2023-11-07T05:31:56Z',
'periodFrom' => '2023-12-25',
'prorate' => [
'fromDate' => '2023-12-25'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-environment: <x-environment>"
],
]);
$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://api.example.com/subscriptions/{subscriptionId}"
payload := strings.NewReader("{\n \"start\": \"2023-12-25\",\n \"end\": \"2023-12-25\",\n \"autoRenewal\": true,\n \"description\": \"<string>\",\n \"items\": [\n {\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"priceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"billAt\": \"2023-11-07T05:31:56Z\",\n \"periodFrom\": \"2023-12-25\",\n \"prorate\": {\n \"fromDate\": \"2023-12-25\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-environment", "<x-environment>")
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.example.com/subscriptions/{subscriptionId}")
.header("x-environment", "<x-environment>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"start\": \"2023-12-25\",\n \"end\": \"2023-12-25\",\n \"autoRenewal\": true,\n \"description\": \"<string>\",\n \"items\": [\n {\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"priceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"billAt\": \"2023-11-07T05:31:56Z\",\n \"periodFrom\": \"2023-12-25\",\n \"prorate\": {\n \"fromDate\": \"2023-12-25\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/subscriptions/{subscriptionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-environment"] = '<x-environment>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start\": \"2023-12-25\",\n \"end\": \"2023-12-25\",\n \"autoRenewal\": true,\n \"description\": \"<string>\",\n \"items\": [\n {\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"priceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"billAt\": \"2023-11-07T05:31:56Z\",\n \"periodFrom\": \"2023-12-25\",\n \"prorate\": {\n \"fromDate\": \"2023-12-25\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"handle": "<string>",
"currency": "USD",
"term": {
"start": "2023-12-25",
"end": "2023-12-25"
},
"autoRenewal": true,
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"billAt": "2023-11-07T05:31:56Z",
"period": {
"start": "2023-12-25",
"end": "2023-12-25"
},
"quantity": 123,
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"price": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
],
"createdAt": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Subscriptions
Update subscription
Updates a given subscription and items. Update cannot be partial, a full request mus be sent.
PUT
/
subscriptions
/
{subscriptionId}
Update subscription
curl --request PUT \
--url https://api.example.com/subscriptions/{subscriptionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-environment: <x-environment>' \
--data '
{
"start": "2023-12-25",
"end": "2023-12-25",
"autoRenewal": true,
"description": "<string>",
"items": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"billAt": "2023-11-07T05:31:56Z",
"periodFrom": "2023-12-25",
"prorate": {
"fromDate": "2023-12-25"
}
}
]
}
'import requests
url = "https://api.example.com/subscriptions/{subscriptionId}"
payload = {
"start": "2023-12-25",
"end": "2023-12-25",
"autoRenewal": True,
"description": "<string>",
"items": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"billAt": "2023-11-07T05:31:56Z",
"periodFrom": "2023-12-25",
"prorate": { "fromDate": "2023-12-25" }
}
]
}
headers = {
"x-environment": "<x-environment>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-environment': '<x-environment>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
start: '2023-12-25',
end: '2023-12-25',
autoRenewal: true,
description: '<string>',
items: [
{
productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
priceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 123,
billAt: '2023-11-07T05:31:56Z',
periodFrom: '2023-12-25',
prorate: {fromDate: '2023-12-25'}
}
]
})
};
fetch('https://api.example.com/subscriptions/{subscriptionId}', 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://api.example.com/subscriptions/{subscriptionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'start' => '2023-12-25',
'end' => '2023-12-25',
'autoRenewal' => true,
'description' => '<string>',
'items' => [
[
'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'priceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 123,
'billAt' => '2023-11-07T05:31:56Z',
'periodFrom' => '2023-12-25',
'prorate' => [
'fromDate' => '2023-12-25'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-environment: <x-environment>"
],
]);
$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://api.example.com/subscriptions/{subscriptionId}"
payload := strings.NewReader("{\n \"start\": \"2023-12-25\",\n \"end\": \"2023-12-25\",\n \"autoRenewal\": true,\n \"description\": \"<string>\",\n \"items\": [\n {\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"priceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"billAt\": \"2023-11-07T05:31:56Z\",\n \"periodFrom\": \"2023-12-25\",\n \"prorate\": {\n \"fromDate\": \"2023-12-25\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-environment", "<x-environment>")
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.example.com/subscriptions/{subscriptionId}")
.header("x-environment", "<x-environment>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"start\": \"2023-12-25\",\n \"end\": \"2023-12-25\",\n \"autoRenewal\": true,\n \"description\": \"<string>\",\n \"items\": [\n {\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"priceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"billAt\": \"2023-11-07T05:31:56Z\",\n \"periodFrom\": \"2023-12-25\",\n \"prorate\": {\n \"fromDate\": \"2023-12-25\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/subscriptions/{subscriptionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-environment"] = '<x-environment>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start\": \"2023-12-25\",\n \"end\": \"2023-12-25\",\n \"autoRenewal\": true,\n \"description\": \"<string>\",\n \"items\": [\n {\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"priceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"billAt\": \"2023-11-07T05:31:56Z\",\n \"periodFrom\": \"2023-12-25\",\n \"prorate\": {\n \"fromDate\": \"2023-12-25\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"handle": "<string>",
"currency": "USD",
"term": {
"start": "2023-12-25",
"end": "2023-12-25"
},
"autoRenewal": true,
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"billAt": "2023-11-07T05:31:56Z",
"period": {
"start": "2023-12-25",
"end": "2023-12-25"
},
"quantity": 123,
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"price": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
],
"createdAt": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Headers
Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.
Path Parameters
Id of the given subscription.
Body
application/json
Update request of subscription.
Sets a start date for the subscription.
Sets an end date for the subscription. Must be later than the Start.
If set, the subscription will be automatically renewed. An End must be set to allow automatically renewal.
Sets a description for the subscription. 4000 characters maximum.
Items to update. If not set, the subscription will be updated without changing the items.
Pass an empty array to remove all charges.
Show child attributes
Show child attributes
Response
OK
Id of subscription.
A unique handle of the subscription.
Currency of the subscription.
Example:
"USD"
Show child attributes
Show child attributes
For termed subscription, auto renewal is optional and will automatically renew the subscription.
Items of the subscription.
Show child attributes
Show child attributes
Was this page helpful?