Accept an exact organization IU Rate Card offer (legacy v2 Seller Account route)
curl --request POST \
--url https://api.interchange.io/api/v2/billing/storefront-rate-card/accept \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"offerVersion": "<string>",
"planId": "<string>",
"idempotencyKey": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/billing/storefront-rate-card/accept"
payload = {
"offerVersion": "<string>",
"planId": "<string>",
"idempotencyKey": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({offerVersion: '<string>', planId: '<string>', idempotencyKey: '<string>'})
};
fetch('https://api.interchange.io/api/v2/billing/storefront-rate-card/accept', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "<string>",
"acceptingCustomerId": 4503599627370496,
"contractId": "<string>",
"agreementDocumentId": "<string>",
"tosVersion": "<string>",
"rateCardId": "<string>",
"rateCardPublicVersion": "<string>",
"planId": "<string>",
"planCode": "<string>",
"planName": "<string>",
"predecessorBindingId": "<string>",
"offerVersion": "<string>",
"entitlementBundle": null,
"supportPackage": {
"schemaVersion": 1,
"kind": "UNLIMITED_NAMED_SUPPORT",
"displayName": "<string>"
},
"proposal": {
"schemaVersion": 1,
"documentTitle": "<string>",
"executiveSummary": "<string>",
"scope": {
"included": [
"<string>"
],
"exclusions": []
},
"term": {
"serviceStart": {
"kind": "ON_ACCEPTANCE"
},
"initialTermMonths": 60,
"renewal": {
"kind": "NO_AUTOMATIC_RENEWAL"
},
"terminationForConvenience": {
"noticeDays": 182
}
},
"paymentOptions": [
{
"kind": "MONTHLY",
"optionKey": "<string>",
"displayName": "<string>",
"monthlyAmountMinor": 4503599627370495,
"termMonths": 60,
"paymentTermsDays": 182,
"collectionMethods": []
}
],
"organizationNameAtIssue": "<string>"
},
"selectedPaymentOption": {
"kind": "MONTHLY",
"optionKey": "<string>",
"displayName": "<string>",
"monthlyAmountMinor": 4503599627370495,
"termMonths": 60,
"paymentTermsDays": 182,
"collectionMethods": []
},
"termStart": "2023-11-07T05:31:56Z",
"termEnd": "2023-11-07T05:31:56Z",
"listCommitmentMinor": 4503599627370495,
"listOverageUnitAmountMinor": 4503599627370495,
"includedIus": 4503599627370495,
"discountAuthorizationId": "<string>",
"discountBasisPoints": 4999,
"netCommitmentMinor": 4503599627370495,
"netOverageUnitAmountMinor": 4503599627370495,
"billingPeriodMonths": 1,
"rolloverPolicy": {
"capBasisPoints": 2500,
"expiresAfterBillingPeriods": 1
},
"paymentTermsDays": 4503599627370496,
"acceptedByUserId": "<string>",
"acceptedAt": "2023-11-07T05:31:56Z",
"activityTerms": [
{
"activityCode": "ACTIVATED_SOCIAL_ACCOUNT_MONTH",
"displayName": "<string>",
"iuAmountMilli": 1073741824,
"billingPeriodMonths": 1,
"includedBackfillMonths": 60
}
],
"activitySchedule": [
{
"displayName": "<string>",
"unitCount": 4503599627370496,
"standardIuAmountMilli": 1073741824,
"customIuAmountMilli": 1073741824,
"effectiveIuAmountMilli": 1073741824,
"billable": true,
"includedBackfillMonths": 60
}
],
"effectiveRateCard": {
"version": "<string>",
"displayName": "<string>",
"commercialOfferId": "<string>",
"renewalBehavior": "PIN_EXACT",
"adjustments": {
"price": {
"kind": "PERCENT",
"basisPoints": 5000
},
"platform": null,
"activityTerms": [],
"setupCredit": null
},
"rateCardSnapshot": null
}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Storefront Billing
Accept an exact organization IU Rate Card offer (legacy v2 Seller Account route)
Creates the initial immutable paid-plan acceptance record for a direct human organization admin. The server re-resolves the Rate Card, public plan, governing agreement, and discount; a changed displayed offer returns conflict and must be reviewed again. Prices are never accepted from the client.
POST
/
billing
/
storefront-rate-card
/
accept
Accept an exact organization IU Rate Card offer (legacy v2 Seller Account route)
curl --request POST \
--url https://api.interchange.io/api/v2/billing/storefront-rate-card/accept \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"offerVersion": "<string>",
"planId": "<string>",
"idempotencyKey": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/billing/storefront-rate-card/accept"
payload = {
"offerVersion": "<string>",
"planId": "<string>",
"idempotencyKey": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({offerVersion: '<string>', planId: '<string>', idempotencyKey: '<string>'})
};
fetch('https://api.interchange.io/api/v2/billing/storefront-rate-card/accept', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "<string>",
"acceptingCustomerId": 4503599627370496,
"contractId": "<string>",
"agreementDocumentId": "<string>",
"tosVersion": "<string>",
"rateCardId": "<string>",
"rateCardPublicVersion": "<string>",
"planId": "<string>",
"planCode": "<string>",
"planName": "<string>",
"predecessorBindingId": "<string>",
"offerVersion": "<string>",
"entitlementBundle": null,
"supportPackage": {
"schemaVersion": 1,
"kind": "UNLIMITED_NAMED_SUPPORT",
"displayName": "<string>"
},
"proposal": {
"schemaVersion": 1,
"documentTitle": "<string>",
"executiveSummary": "<string>",
"scope": {
"included": [
"<string>"
],
"exclusions": []
},
"term": {
"serviceStart": {
"kind": "ON_ACCEPTANCE"
},
"initialTermMonths": 60,
"renewal": {
"kind": "NO_AUTOMATIC_RENEWAL"
},
"terminationForConvenience": {
"noticeDays": 182
}
},
"paymentOptions": [
{
"kind": "MONTHLY",
"optionKey": "<string>",
"displayName": "<string>",
"monthlyAmountMinor": 4503599627370495,
"termMonths": 60,
"paymentTermsDays": 182,
"collectionMethods": []
}
],
"organizationNameAtIssue": "<string>"
},
"selectedPaymentOption": {
"kind": "MONTHLY",
"optionKey": "<string>",
"displayName": "<string>",
"monthlyAmountMinor": 4503599627370495,
"termMonths": 60,
"paymentTermsDays": 182,
"collectionMethods": []
},
"termStart": "2023-11-07T05:31:56Z",
"termEnd": "2023-11-07T05:31:56Z",
"listCommitmentMinor": 4503599627370495,
"listOverageUnitAmountMinor": 4503599627370495,
"includedIus": 4503599627370495,
"discountAuthorizationId": "<string>",
"discountBasisPoints": 4999,
"netCommitmentMinor": 4503599627370495,
"netOverageUnitAmountMinor": 4503599627370495,
"billingPeriodMonths": 1,
"rolloverPolicy": {
"capBasisPoints": 2500,
"expiresAfterBillingPeriods": 1
},
"paymentTermsDays": 4503599627370496,
"acceptedByUserId": "<string>",
"acceptedAt": "2023-11-07T05:31:56Z",
"activityTerms": [
{
"activityCode": "ACTIVATED_SOCIAL_ACCOUNT_MONTH",
"displayName": "<string>",
"iuAmountMilli": 1073741824,
"billingPeriodMonths": 1,
"includedBackfillMonths": 60
}
],
"activitySchedule": [
{
"displayName": "<string>",
"unitCount": 4503599627370496,
"standardIuAmountMilli": 1073741824,
"customIuAmountMilli": 1073741824,
"effectiveIuAmountMilli": 1073741824,
"billable": true,
"includedBackfillMonths": 60
}
],
"effectiveRateCard": {
"version": "<string>",
"displayName": "<string>",
"commercialOfferId": "<string>",
"renewalBehavior": "PIN_EXACT",
"adjustments": {
"price": {
"kind": "PERCENT",
"basisPoints": 5000
},
"platform": null,
"activityTerms": [],
"setupCredit": null
},
"rateCardSnapshot": null
}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Body
application/json
Response
Accept an exact organization IU Rate Card offer (legacy v2 Seller Account route)
Show child attributes
Show child attributes
⌘I