Choose the billing cadence of an offering on your brand
curl --request PUT \
--url https://api.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Brand-Id: <x-brand-id>' \
--data '{}'import requests
url = "https://api.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence"
payload = {}
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-Brand-Id": "<x-brand-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'Idempotency-Key': '<idempotency-key>',
'X-Brand-Id': '<x-brand-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
};
fetch('https://api.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence', 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.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence",
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([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"X-Brand-Id: <x-brand-id>"
],
]);
$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.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("X-Brand-Id", "<x-brand-id>")
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.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence")
.header("Idempotency-Key", "<idempotency-key>")
.header("X-Brand-Id", "<x-brand-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-Brand-Id"] = '<x-brand-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"data": {
"billing": "monthly",
"billing_frequency": "monthly",
"brand_id": "<string>",
"offering_ref": "<string>",
"shipping_frequency": "none",
"shipping_interval_days": 123
}
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>"
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>"
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>"
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>"
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>"
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>",
"collection": "<string>"
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>"
}Offering configuration
Choose the billing cadence of an offering on your brand
Chooses how members are billed for one offering on one of your brands: monthly (a charge every month of the medication’s supply) or upfront (one charge for the whole term). Only a cadence that is compatible with the offering’s supply and its shipping rules is accepted; any other is refused with the reason and the cadences you can choose instead. You never set the shipping cadence: it always follows the offering’s supply, and a body that names one is refused. When exactly one billing cadence is compatible, the platform sets it for you when the offering is enabled and already has its copy, or when its copy is adopted, so this call is needed only when you have a choice. The offering must be enabled on the brand and have its copy (adopt the starter merchandising, or publish your own) before a cadence can be chosen. Choosing again replaces your earlier choice; the platform never overwrites a choice you made. Every change is recorded in your brand’s audit trail, attributed to your account. Repeating a completed request with the same Idempotency-Key returns the original result.
PUT
/
v1
/
account
/
brands
/
{brand_id}
/
offerings
/
{offering_ref}
/
billing-cadence
Choose the billing cadence of an offering on your brand
curl --request PUT \
--url https://api.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Brand-Id: <x-brand-id>' \
--data '{}'import requests
url = "https://api.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence"
payload = {}
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-Brand-Id": "<x-brand-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'Idempotency-Key': '<idempotency-key>',
'X-Brand-Id': '<x-brand-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
};
fetch('https://api.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence', 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.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence",
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([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"X-Brand-Id: <x-brand-id>"
],
]);
$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.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("X-Brand-Id", "<x-brand-id>")
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.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence")
.header("Idempotency-Key", "<idempotency-key>")
.header("X-Brand-Id", "<x-brand-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.staging.purplelabelmd.com/v1/account/brands/{brand_id}/offerings/{offering_ref}/billing-cadence")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-Brand-Id"] = '<x-brand-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"data": {
"billing": "monthly",
"billing_frequency": "monthly",
"brand_id": "<string>",
"offering_ref": "<string>",
"shipping_frequency": "none",
"shipping_interval_days": 123
}
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>"
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>"
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>"
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>"
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>"
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>",
"collection": "<string>"
}{
"status": 123,
"title": "<string>",
"adoption": {
"applied": true,
"counts": {
"rows_examined": 1,
"rows_written": 1,
"values_written": 1
},
"mode": "dry-run",
"report_ref": {
"adoption_run_id": "<string>",
"medication_sku": "<string>"
},
"run_id": "<string>",
"receipt": {
"at": "2023-11-07T05:31:56Z",
"groups_digest": "<string>",
"preview_digest": "<string>",
"request_digest": "<string>",
"run_id": "<string>",
"served_digest": "<string>"
},
"refused": true
},
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "<string>",
"type": "<string>"
}Authorizations
Per-client API key (M2M). Presented as Authorization: Bearer <key>.
Headers
Required on every mutation. Replaying the same request with the same key returns the original result; reusing the key with a materially different request is rejected 409 with machine code IDEMPOTENCY_CONFLICT.
Minimum string length:
1Your brand id (brd_...). It must be one of the brands your API key's account owns; with a publishable key it must be the one brand the key was issued for. A missing or malformed value is refused with 400, and an unknown or foreign brand with 404.
Pattern:
^brd_[A-Za-z0-9][A-Za-z0-9_-]*$Path Parameters
The brand the offering is enabled on. Must be one of your account's own brands.
The offering code, as listed for your brand.
Body
application/json
The billing cadence you choose for the offering. Nothing else rides the body: the shipping cadence always follows the offering's supply, and the brand and offering come from the path.
monthly charges every month of the medication's supply; upfront charges once for the whole term.
Available options:
monthly, upfront Response
the billing cadence you chose, with the shipping cadence it follows; or an idempotent replay of the original result
The billing cadence now set for the offering, and the shipping cadence it follows.
Show child attributes
Show child attributes