curl --request POST \
--url https://int-prodtest.m1amdocs.io/v1/entitlement \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"account": {
"id": "<string>",
"externalId": "<string>",
"partnerCustomerIds": [
{
"partnerCode": "<string>",
"partnerCustomerId": "<string>"
}
],
"parent": "<string>"
},
"productCodes": [
"<string>"
],
"subscriptionId": "<string>",
"metadata": {}
}
'import requests
url = "https://int-prodtest.m1amdocs.io/v1/entitlement"
payload = {
"account": {
"id": "<string>",
"externalId": "<string>",
"partnerCustomerIds": [
{
"partnerCode": "<string>",
"partnerCustomerId": "<string>"
}
],
"parent": "<string>"
},
"productCodes": ["<string>"],
"subscriptionId": "<string>",
"metadata": {}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account: {
id: '<string>',
externalId: '<string>',
partnerCustomerIds: [{partnerCode: '<string>', partnerCustomerId: '<string>'}],
parent: '<string>'
},
productCodes: ['<string>'],
subscriptionId: '<string>',
metadata: {}
})
};
fetch('https://int-prodtest.m1amdocs.io/v1/entitlement', 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/v1/entitlement",
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([
'account' => [
'id' => '<string>',
'externalId' => '<string>',
'partnerCustomerIds' => [
[
'partnerCode' => '<string>',
'partnerCustomerId' => '<string>'
]
],
'parent' => '<string>'
],
'productCodes' => [
'<string>'
],
'subscriptionId' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://int-prodtest.m1amdocs.io/v1/entitlement"
payload := strings.NewReader("{\n \"account\": {\n \"id\": \"<string>\",\n \"externalId\": \"<string>\",\n \"partnerCustomerIds\": [\n {\n \"partnerCode\": \"<string>\",\n \"partnerCustomerId\": \"<string>\"\n }\n ],\n \"parent\": \"<string>\"\n },\n \"productCodes\": [\n \"<string>\"\n ],\n \"subscriptionId\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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/v1/entitlement")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account\": {\n \"id\": \"<string>\",\n \"externalId\": \"<string>\",\n \"partnerCustomerIds\": [\n {\n \"partnerCode\": \"<string>\",\n \"partnerCustomerId\": \"<string>\"\n }\n ],\n \"parent\": \"<string>\"\n },\n \"productCodes\": [\n \"<string>\"\n ],\n \"subscriptionId\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://int-prodtest.m1amdocs.io/v1/entitlement")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account\": {\n \"id\": \"<string>\",\n \"externalId\": \"<string>\",\n \"partnerCustomerIds\": [\n {\n \"partnerCode\": \"<string>\",\n \"partnerCustomerId\": \"<string>\"\n }\n ],\n \"parent\": \"<string>\"\n },\n \"productCodes\": [\n \"<string>\"\n ],\n \"subscriptionId\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body[
{
"partnerSubscriptionId": "<string>",
"productCode": "<string>",
"createdDate": "<string>",
"serviceStatus": "UNPROVISIONED",
"account": {
"id": "<string>",
"externalId": "<string>",
"partnerCustomerId": "<string>",
"parent": "<string>"
},
"subscriptionId": "<string>",
"externalPartnerSubscriptionId": "<string>",
"partnerCode": "<string>",
"quantity": 500,
"updatedDate": "<string>",
"startServiceDate": "<string>",
"endServiceDate": "<string>",
"activatedDate": "<string>"
}
]{
"code": "invalid-request",
"message": "<string>",
"validationErrors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "authentication-required",
"message": "<string>"
}{
"code": "forbidden",
"message": "<string>"
}{
"code": "input-conflict",
"message": "<string>"
}Create Entitlement
Create Create
curl --request POST \
--url https://int-prodtest.m1amdocs.io/v1/entitlement \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"account": {
"id": "<string>",
"externalId": "<string>",
"partnerCustomerIds": [
{
"partnerCode": "<string>",
"partnerCustomerId": "<string>"
}
],
"parent": "<string>"
},
"productCodes": [
"<string>"
],
"subscriptionId": "<string>",
"metadata": {}
}
'import requests
url = "https://int-prodtest.m1amdocs.io/v1/entitlement"
payload = {
"account": {
"id": "<string>",
"externalId": "<string>",
"partnerCustomerIds": [
{
"partnerCode": "<string>",
"partnerCustomerId": "<string>"
}
],
"parent": "<string>"
},
"productCodes": ["<string>"],
"subscriptionId": "<string>",
"metadata": {}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account: {
id: '<string>',
externalId: '<string>',
partnerCustomerIds: [{partnerCode: '<string>', partnerCustomerId: '<string>'}],
parent: '<string>'
},
productCodes: ['<string>'],
subscriptionId: '<string>',
metadata: {}
})
};
fetch('https://int-prodtest.m1amdocs.io/v1/entitlement', 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/v1/entitlement",
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([
'account' => [
'id' => '<string>',
'externalId' => '<string>',
'partnerCustomerIds' => [
[
'partnerCode' => '<string>',
'partnerCustomerId' => '<string>'
]
],
'parent' => '<string>'
],
'productCodes' => [
'<string>'
],
'subscriptionId' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://int-prodtest.m1amdocs.io/v1/entitlement"
payload := strings.NewReader("{\n \"account\": {\n \"id\": \"<string>\",\n \"externalId\": \"<string>\",\n \"partnerCustomerIds\": [\n {\n \"partnerCode\": \"<string>\",\n \"partnerCustomerId\": \"<string>\"\n }\n ],\n \"parent\": \"<string>\"\n },\n \"productCodes\": [\n \"<string>\"\n ],\n \"subscriptionId\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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/v1/entitlement")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account\": {\n \"id\": \"<string>\",\n \"externalId\": \"<string>\",\n \"partnerCustomerIds\": [\n {\n \"partnerCode\": \"<string>\",\n \"partnerCustomerId\": \"<string>\"\n }\n ],\n \"parent\": \"<string>\"\n },\n \"productCodes\": [\n \"<string>\"\n ],\n \"subscriptionId\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://int-prodtest.m1amdocs.io/v1/entitlement")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account\": {\n \"id\": \"<string>\",\n \"externalId\": \"<string>\",\n \"partnerCustomerIds\": [\n {\n \"partnerCode\": \"<string>\",\n \"partnerCustomerId\": \"<string>\"\n }\n ],\n \"parent\": \"<string>\"\n },\n \"productCodes\": [\n \"<string>\"\n ],\n \"subscriptionId\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body[
{
"partnerSubscriptionId": "<string>",
"productCode": "<string>",
"createdDate": "<string>",
"serviceStatus": "UNPROVISIONED",
"account": {
"id": "<string>",
"externalId": "<string>",
"partnerCustomerId": "<string>",
"parent": "<string>"
},
"subscriptionId": "<string>",
"externalPartnerSubscriptionId": "<string>",
"partnerCode": "<string>",
"quantity": 500,
"updatedDate": "<string>",
"startServiceDate": "<string>",
"endServiceDate": "<string>",
"activatedDate": "<string>"
}
]{
"code": "invalid-request",
"message": "<string>",
"validationErrors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "authentication-required",
"message": "<string>"
}{
"code": "forbidden",
"message": "<string>"
}{
"code": "input-conflict",
"message": "<string>"
}Authorizations
The authorization key obtained from MarketONE.
Body
Authentication mechanism/details for webhook endpoint
The Account represents an aggregator’s customer. As such it can contain as much or as little information as you collect about the customers (people or organizations) to which you offer billing and subscriptions.
Show child attributes
Show child attributes
list of product codes
The id of the subscription as tracked in the subscription management system
128A set of key/value pairs that you can attach to an object. Useful for storing additional information.
Show child attributes
Show child attributes
Response
OK
MarketONE partner service provisioning record identifier.
256The product code defined by the partner identified by partner code.
128The timestamp (ISO 8601 format) when the partner service provisioning information record was created.
Status of the partner service MarketONE information. UNPROVISIONED indicates that the record was created by the callback response was not received. INACTIVE indicates the provisioning callback was sucesfully received by the partner service, but it has not been claimed by any service user yet. ACTIVE indicates that the service entitlement has been sucesfully provisioned, and a partner service user has claimed it. CANCELLATION-IN-PROGRESS indicates that the a de-provisioning request is pending. CANCELLED indicates that the de-provisioning request confirmation has been received.
UNPROVISIONED, INACTIVE, ACTIVE, CANCELLATION-IN-PROGRESS, CANCELLED, UPDATE-IN-PROGRESS, PAUSED, PAUSE-IN-PROGRESS, RESUME-IN-PROGRESS 50Show child attributes
Show child attributes
The id subscription associated with this partner service.
128The identifier returned by the partner from the "AddSubscription" callback.
256The partner code as set by the partner admin in MarketONE.
15represents the quantity that this entitlement should enable. Required for products with QUANTITY entitlementType.
500
The timestamp (ISO 8601 format) when the partner service provisioning information record was updated.
The timestamp (ISO 8601 format) when the partner service provisioning information record was created.
The timestamp (ISO 8601 format) when the partner service provisioning information record was updated.
The timestamp (ISO 8601 format) when the partner subscription was activated (optional)
Was this page helpful?

