Create Subscription
This API enables you to create subscription orders of a recurring nature for products and services available from the retailer.
URI Summary
|
Operation |
Action |
URI Template |
URI Example |
Transaction Type |
Unique RequestID Needed for Duplicate Detection? |
Non-URI Request Payload |
Response |
|---|---|---|---|---|---|---|---|
| Create | POST | /order-subscription/sellers/{sellerId}/subscriptions | /order-subscription /sellers/TMSUS/subscriptions | Create a new subscription. | N0 | JSON | 200 + JSON response |
URI domain name: Radial recommends using the new domain at apg.radial.com. To connect to production Radial APIs, use the following form of the URL:
https://apg.radial.com/v1.0/proxyname/storecode/function
You should have received the applicable information for proxyname, storecode, and function from your Radial representative.
Note: The old domain will still be in operation until further notice from Radial. For more information on Radial API URIs, see API Requests and Responses.
Examples
Request JSON
Copy
"subscriptionInfo": {
"subscriptionName": "Mani07136",
"recurrenceId": "1234567890111213",
"frequency": {
"type": "DAY",
"value": 31
},
"walletId": "151116303930448014737441"
},
"order": {
"sellerId": "TMSUS",
"customerOrderId": "00026Mani35",
"orderTimestamp": "2021-06-24T16:18:39.388Z",
"customerInfo": {
"customerId": "7f7b5670-9794-4943-8bf3-a26a4f728410",
"customerName": "Indiana R Jones",
"email": "TESTFRAUD@radial.com",
"phone": "999-999-9999",
"honorific": "Mr.",
"firstName": "Indiana",
"middleName": "R",
"lastName": "Jones"
},
"source": {
"value": "EB2C",
"type": "TestType",
"code": "TestCode"
},
"shipGroups": {
"address_1": {
"addressId": "address_1",
"chargeType": "FLATRATE",
"shippingMethod": {
"name": "ANY_2DAY",
"displayValue": "ANY_2DAY"
},
"lineNos": [
"1"
]
}
},
"addresses": {
"address_1": {
"addressType": "MailingAddress",
"addressId": "address_1",
"line1": "630 Allendale Road",
"line2": "Suite 200",
"firstName": "Indiana",
"lastName": "Jones",
"city": "King of Prussia",
"phone": "610-222-3333",
"stateOrProvinceCode": "PA",
"countryCode": "US",
"zipCode": "19406"
}
},
"paymentMethods": {
"1234": {
"paymentMethodCode": "CC",
"tenderType": "VC",
"amount": 0,
"billingAddressId": "address_1",
"displayPaymentAccountNumber": "1234",
"name": "creditcard",
"isToken": "true"
}
},
"lineItems": {
"1": {
"lineNo": "1",
"fulfillmentMethod": "SHIP_TO_HOME",
"quantity": 2,
"item": {
"itemId": "21-ISPUProd01",
"description": "Black Tennis Shoes",
"color": {
"code": "Brown",
"value": "700"
},
"size": {
"code": "6-M",
"value": "6-M"
}
},
"lineCharges": {
"merchandise": {
"perUnit": 2.00,
"perLine": 0,
"amount": 4.00,
"taxClass": "76480",
"taxes": {
"stateTax": {
"amount": 0.3,
"attributes": {
"taxType": "SELLER_USE",
"taxability": "TAXABLE",
"situs": "DESTINATION",
"jurisdiction": "TEXAS",
"jurisdictionId": "35763",
"jurisdictionLevel": "STATE",
"imposition": "Sales and Use Tax",
"impositionType": "General Sales and Use Tax",
"effectiveRate": "0.2",
"taxableAmount": "0.2",
"ExemptAmount": "0.0",
"NonTaxableAmount": "0.0",
"sellerRegistrationId": "12345"
}
},
"citytax": {
"amount": 0.04,
"attributes": {
"taxType": "SELLER_USE",
"taxability": "TAXABLE",
"situs": "DESTINATION",
"jurisdiction": "TEXAS",
"jurisdictionId": "35763",
"jurisdictionLevel": "CITY",
"imposition": "Sales Use Tax",
"impositionType": "General Sales and Use Tax",
"effectiveRate": "0.2",
"taxableAmount": "0.2",
"ExemptAmount": "0.0",
"NonTaxableAmount": "0.0",
"sellerRegistrationId": "12345"
}
},
"metroTax": {
"amount": 0.04,
"attributes": {
"taxType": "SELLER_USE",
"taxability": "TAXABLE",
"situs": "DESTINATION",
"jurisdiction": "TEXAS",
"jurisdictionId": "35763",
"jurisdictionLevel": "METRO",
"imposition": "Sales and Use Tax",
"impositionType": "General Sales and Use Tax",
"effectiveRate": "0.2",
"taxableAmount": "0.2",
"ExemptAmount": "0.0",
"NonTaxableAmount": "0.0",
"sellerRegistrationId": "12345"
}
}
},
"chargeCategory": "merchandise",
"total": {
"grandTax": 0.38,
"grandDiscount": 0,
"grandTotal": 4.38,
"grandTotalByChargeCategory": {
"merchandise": 4.38
}
}
},
"shipping": {
"perUnit": 0.00,
"perLine": 1.00,
"amount": 1.00,
"taxClass": "91000",
"taxes": {
"stateTax": {
"amount": 0.12,
"attributes": {
"taxType": "SELLER_USE",
"taxability": "TAXABLE",
"situs": "DESTINATION",
"jurisdiction": "TEXAS",
"jurisdictionId": "35763",
"jurisdictionLevel": "STATE",
"imposition": "Sales and Use Tax",
"impositionType": "General Sales and Use Tax",
"effectiveRate": "0.2",
"taxableAmount": "0.1",
"ExemptAmount": "0.0",
"NonTaxableAmount": "0.0",
"sellerRegistrationId": "12345"
}
}
},
"chargeCategory": "shipping",
"total": {
"grandTax": 0.12,
"grandDiscount": 0,
"grandTotal": 1.12,
"grandTotalByChargeCategory": {
"shipping": 1.12
}
}
}
},
"reservationId": "0002636347137553",
"attributes": {
"FragranceName": "Eucalyptus Mint1",
"FragranceName1": "Eucalyptus1"
},
"lineTotal": {
"grandTax": 0.50,
"grandDiscount": 0,
"grandTotal": 5.50,
"grandTotalByChargeCategory": {
"merchandise": 4.38,
"shipping": 1.12
}
}
}
},
"orderHistoryUrl": "https://www.radial.com/on/demandware.store/Sites-BathAndBodyWorks-Site/en_US/Order-Track?orderID=10468790",
"locale": "en_US",
"currency": "USD",
"levelOfService": "REGULAR",
"context": {
"browserData": {
"metadata": {
"hostName": "172.58.96.188",
"ipAddress": "172.58.96.188",
"sessionId": "59iF5imRzBPXVZZlMCR5nkg_Gg3l3i3cxeI",
"connection": "string",
"userAgent": "Mozilla",
"userCookie": "423",
"userAgentOS": "Windows",
"userAgentCPU": "string",
"headerFrom": "string",
"embeddedWebBrowserFrom": "TF1;015;;;;;;;;;;;;",
"javascriptData": "string",
"referrer": "https://www.bathandbodyworks.com/cart?dwcont=C959357099"
},
"cookies": [
"string"
],
"httpAcceptData": {
"contentTypes": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
"encoding": "gzip",
"language": "en-us",
"charSet": "UTF-8"
}
},
"sessionInfo": {
"TimeSpentOnSite": "00:08:01",
"AuthorizationAttempts": "1"
},
"orderTimestamp": "2021-06-24T16:18:39.388Z"
},
"attributes": {
"ORDTAXERR": "N",
"RDFUID": "b59d00eb-2e1d-4c92-a9d4-90c7026df4e1_1623904915866",
"ORDERCHANNEL": "WEB"
},
"orderTotal": {
"grandTax": 0.5,
"grandDiscount": 0,
"grandTotal": 5.5,
"grandTotalByChargeCategory": {
"merchandise": 4.38,
"shipping": 1.12
}
}
}
}Copy
{
"subscriptionId": 6012,
"lastOrderDate": "2022-02-17",
"nextOrderDate": "2022-03-20",
"status": "ACTIVE",
"subscriptionInfo": {
"subscriptionId": 6012,
"subscriptionName": "Mani07136",
"recurrenceId": "1234567890111213",
"frequency": {
"type": "DAY",
"value": 31
},
"walletId": "151116303930448014737441"
},
"order": {
"sellerId": "TMSUS",
"customerOrderId": "00026Mani35",
"orderTimestamp": "2021-06-24T16:18:39.388Z",
"customerInfo": {
"customerId": "7f7b5670-9794-4943-8bf3-a26a4f728410",
"customerName": "Indiana R Jones",
"email": "TESTFRAUD@radial.com",
"phone": "999-999-9999",
"honorific": "Mr.",
"firstName": "Indiana",
"middleName": "R",
"lastName": "Jones"
},
"source": {
"value": "EB2C",
"type": "TestType",
"code": "TestCode"
},
"shipGroups": {
"address_1": {
"addressId": "address_1",
"chargeType": "FLATRATE",
"shippingMethod": {
"name": "ANY_2DAY",
"displayValue": "ANY_2DAY"
},
"lineNos": [
"1"
]
}
},
"addresses": {
"address_1": {
"addressType": "MailingAddress",
"line1": "630 Allendale Road",
"line2": "Suite 200",
"firstName": "Indiana",
"lastName": "Jones",
"city": "King of Prussia",
"phone": "610-222-3333",
"stateOrProvinceCode": "PA",
"countryCode": "US",
"zipCode": "19406"
}
},
"lineItems": {
"1": {
"lineNo": "1",
"fulfillmentMethod": "SHIP_TO_HOME",
"quantity": 2,
"item": {
"itemId": "21-ISPUProd01",
"description": "Black Tennis Shoes",
"color": {
"code": "Brown",
"value": "700"
},
"size": {
"code": "6-M",
"value": "6-M"
}
},
"lineCharges": {
"shipping": {
"perUnit": 0,
"perLine": 1,
"amount": 1,
"taxClass": "91000",
"taxes": {
"stateTax": {
"amount": 0.12,
"attributes": {
"taxType": "SELLER_USE",
"taxability": "TAXABLE",
"situs": "DESTINATION",
"jurisdiction": "TEXAS",
"jurisdictionId": "35763",
"jurisdictionLevel": "STATE",
"imposition": "Sales and Use Tax",
"impositionType": "General Sales and Use Tax",
"effectiveRate": "0.2",
"taxableAmount": "0.1",
"ExemptAmount": "0.0",
"NonTaxableAmount": "0.0",
"sellerRegistrationId": "12345"
}
}
},
"total": {
"grandTax": 0.12,
"grandDiscount": 0,
"grandTotal": 1.12
}
},
"merchandise": {
"perUnit": 2,
"perLine": 0,
"amount": 4,
"taxClass": "76480",
"taxes": {
"stateTax": {
"amount": 0.3,
"attributes": {
"taxType": "SELLER_USE",
"taxability": "TAXABLE",
"situs": "DESTINATION",
"jurisdiction": "TEXAS",
"jurisdictionId": "35763",
"jurisdictionLevel": "STATE",
"imposition": "Sales and Use Tax",
"impositionType": "General Sales and Use Tax",
"effectiveRate": "0.2",
"taxableAmount": "0.2",
"ExemptAmount": "0.0",
"NonTaxableAmount": "0.0",
"sellerRegistrationId": "12345"
}
},
"citytax": {
"amount": 0.04,
"attributes": {
"taxType": "SELLER_USE",
"taxability": "TAXABLE",
"situs": "DESTINATION",
"jurisdiction": "TEXAS",
"jurisdictionId": "35763",
"jurisdictionLevel": "CITY",
"imposition": "Sales Use Tax",
"impositionType": "General Sales and Use Tax",
"effectiveRate": "0.2",
"taxableAmount": "0.2",
"ExemptAmount": "0.0",
"NonTaxableAmount": "0.0",
"sellerRegistrationId": "12345"
}
},
"metroTax": {
"amount": 0.04,
"attributes": {
"taxType": "SELLER_USE",
"taxability": "TAXABLE",
"situs": "DESTINATION",
"jurisdiction": "TEXAS",
"jurisdictionId": "35763",
"jurisdictionLevel": "METRO",
"imposition": "Sales and Use Tax",
"impositionType": "General Sales and Use Tax",
"effectiveRate": "0.2",
"taxableAmount": "0.2",
"ExemptAmount": "0.0",
"NonTaxableAmount": "0.0",
"sellerRegistrationId": "12345"
}
}
},
"total": {
"grandTax": 0.38,
"grandDiscount": 0,
"grandTotal": 4.38
}
}
},
"reservationId": "0002636347137553",
"attributes": {
"FragranceName": "Eucalyptus Mint1",
"FragranceName1": "Eucalyptus1"
},
"lineTotal": {
"grandTax": 0.5,
"grandDiscount": 0,
"grandTotal": 5.5,
"grandTotalByChargeCategory": {
"shipping": 1.12,
"merchandise": 4.38
}
}
}
},
"orderHistoryUrl": "https://www.radial.com/on/demandware.store/Sites-BathAndBodyWorks-Site/en_US/Order-Track?orderID=10468790",
"locale": "en_US",
"currency": "USD",
"levelOfService": "REGULAR",
"context": {
"browserData": {
"metadata": {
"hostName": "172.58.96.188",
"ipAddress": "172.58.96.188",
"sessionId": "59iF5imRzBPXVZZlMCR5nkg_Gg3l3i3cxeI",
"connection": "string",
"userAgent": "Mozilla",
"userCookie": "423",
"userAgentOS": "Windows",
"userAgentCPU": "string",
"headerFrom": "string",
"embeddedWebBrowserFrom": "TF1;015;;;;;;;;;;;;",
"javascriptData": "string",
"referrer": "https://www.bathandbodyworks.com/cart?dwcont=C959357099"
},
"cookies": [
"string"
],
"httpAcceptData": {
"contentTypes": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
"encoding": "gzip",
"language": "en-us",
"charSet": "UTF-8"
}
},
"sessionInfo": {
"TimeSpentOnSite": "00:08:01",
"AuthorizationAttempts": "1"
},
"orderTimestamp": "2021-06-24T16:18:39.388Z"
},
"attributes": {
"ORDTAXERR": "N",
"RDFUID": "b59d00eb-2e1d-4c92-a9d4-90c7026df4e1_1623904915866",
"ORDERCHANNEL": "WEB"
},
"orderTotal": {
"grandTax": 0.5,
"grandDiscount": 0,
"grandTotal": 5.5,
"grandTotalByChargeCategory": {
"shipping": 1.12,
"merchandise": 4.38
}
}
}
}