API Reference
⌘
K
Docs & Guides
API Reference
Introduction
Getting started
Language Specific SDKs
Authorization
Metering Cloud
Meter Definition
Ingest Meters
Custom Ingest Schema
Filtering Out Reported Meters
Querying Reported Usage
Querying Raw Events
Periodic Usage Reports
Customers
Billing Cloud
Account
Product Items
Product Item Price Templates
Queries
Pricing Plans
Invoices
Prepaid Orders
Prepaid Cards
Prepaid Wallet
Customer Promotions
Defining Promotions
Customer Commitment
Billing Analysis
Tax Calculation
Alerts and Webhooks
Notifications (Alerts)
Webhooks
Event Logs
Account Settings
Company Logo
Customer Portal
Session
Usage
Cost
Billing
Prepaid
Notifications
Meters
Usage Events
Pricing Plan
Setup Intent
Payment Method
Settings
Company Logo
Customer Details
Credits Ledger
Rewards History
Docs powered by
Archbee
Billing Cloud
Customer Commitment
Create or update a Subscription Commitment
1min
POST
https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/subscription_commitment
Try it
A contract generator that creates a contract with a subscription.
Authentication
X-API-KEY
apiKey
Body Parameters
body
payment.pricing.commitments.generators.SubscriptionContractGenerator.in
type
string
customerId
string
*
notifyOnClientViolation
boolean
planId
string
*
label
string
*
startTimeInSeconds
integer<int64>
cycles
integer<int32>
*
cycleSubscriptionFee
number
Responses
200
Successful request
payment.pricing.customer.CustomerCommitmentContract.out
contractGenerator
payment.pricing.commitments.generators.ContractGenerator.out
One Of
payment.pricing.commitments.generators.CustomerArrearsContractGenerator.out
contract
payment.pricing.commitments.CommitmentContract.out
firstCustomerPlan
payment.pricing.customer.CustomerProductPlan.out
firstCustomerAppliedPromotions
payment.pricing.customer.CustomerAppliedPromotion.out[]
firstCustomerPrepaidCards
payment.billing.prepaid_to_product.PrepaidCard.out[]
One Of
payment.billing.prepaid_to_product.PrepaidCardByPrice.out
firstPrepaidCardsOrders
payment.pricing.customer.CustomerPrepaid.out[]
One Of
payment.pricing.customer.CustomerPrepaidByPrice.out
creationTimeInSeconds
integer<int64>
PREVIOUS
Create or update an Installments Commitment
NEXT
Create or update an Upfront Commitment with True Up
Docs powered by
Archbee