⌘
K
Amberflo API
Defining Customer Segmentation
POST
/pricing/modeling/price-modeling
Managing Price Models
POST
/pricing/modeling/price-model/product-plan
POST
/bizops
GET
/bizops/customer-sales
GET
/bizops/v2/customer-sales
GET
/bizops/customer-sales/all
GET
/bizops/alerts/all
GET
Get sales objectives by customerId
POST
Update the sales objectives
GET
Get a master list of all game actions
GET
/bizops/milestones
POST
/bizops/milestones
POST
/bizops/extend-duration
POST
/bizops/close-game
POST
/bizops/registration
POST
/bizops/notes
GET
/bizops/notes/list
POST
/bizops/admin
Ingest Meters
GET
/ingest/settings/ingest-schema/{id}
DELETE
/ingest/settings/ingest-schema/{id}
GET
/ingest/settings/ingest-schema
POST
/ingest/settings/ingest-schema
POST
/ingest-snapshot/custom-filtering-rules
GET
/ingest-snapshot/custom-filtering-rules/list
POST
/ingest-snapshot/partition-definition
GET
/ingest-snapshot/partition-definition/all
POST
/ingest-snapshot/customer-partitions
POST
/ingest-snapshot/athena-table-creation
Querying Reported Usage
POST
/usage/via-ts
POST
/usage/explain
GET
/usage/events
GET
/usage/current-usage-rate
POST
/usage/resources-group-statuses
GET
/operations/jobs
POST
/operations/jobs
GET
/operations/jobs/list
GET
/operations/jobs/results
GET
/operations/trackers
PUT
/operations/trackers
POST
/operations/trackers
GET
/operations/trackers/list
GET
/operations/query-tool/metadata
GET
/operations/tracker-runs
PUT
/operations/tracker-runs
POST
/operations/tracker-runs
GET
/operations/tracker-runs/list
GET
/operations/data-sync
POST
/operations/jobs/billing_app
POST
/operations/jobs/data_sync_object_counts
POST
/operations/jobs/run_custom_aggregation
POST
/operations/jobs/run_daily_hourly_aggregation
POST
/operations/jobs/run_hourly_aggregation
POST
/operations/jobs/run_ingest_snapshot
POST
/operations/jobs/run_item_invoice
POST
/operations/jobs/run_locked_product_invoice
POST
/operations/jobs/run_marketplace_payments
POST
/operations/jobs/run_usage_costs
POST
/operations/jobs/usage_app
POST
/operations/jobs-dry-run
POST
/operations/jobs-dry-run/billing_app
POST
/operations/jobs-dry-run/data_sync_object_counts
POST
/operations/jobs-dry-run/run_custom_aggregation
POST
/operations/jobs-dry-run/run_daily_hourly_aggregation
POST
/operations/jobs-dry-run/run_hourly_aggregation
POST
/operations/jobs-dry-run/run_ingest_snapshot
POST
/operations/jobs-dry-run/run_item_invoice
POST
/operations/jobs-dry-run/run_locked_product_invoice
POST
/operations/jobs-dry-run/run_marketplace_payments
POST
/operations/jobs-dry-run/run_usage_costs
POST
/operations/jobs-dry-run/usage_app
POST
/operations/query-tool
POST
/operations/query-tool/aggregator-processed-ingest-messages
POST
/operations/query-tool/aoa_meters_failure
POST
/operations/query-tool/commitment_validation
POST
/operations/query-tool/custom_aggregation_timestamps
POST
/operations/query-tool/custom_aggregation_validation
POST
/operations/query-tool/customer_promotion_explain
POST
/operations/query-tool/data_sync_object_counts
POST
/operations/query-tool/events_filtering_validation
POST
/operations/query-tool/file_search
POST
/operations/query-tool/hourly_hourly_to_daily_hourly_validation
POST
/operations/query-tool/invoice_explain
POST
/operations/query-tool/invoice_late_arrivals_verification
POST
/operations/query-tool/invoice_usage_costs_verification
POST
/operations/query-tool/invoice_usage_verification
POST
/operations/query-tool/item_invoice_usage_verification
POST
/operations/query-tool/locked_invoice_verification
POST
/operations/query-tool/long_lasting_explain
POST
/operations/query-tool/long_lasting_verification
POST
/operations/query-tool/marketplace_payments
POST
/operations/query-tool/meter_event_dedupe
POST
/operations/query-tool/platform_jobs_api
POST
/operations/query-tool/prepaid_credits_verification
POST
/operations/query-tool/rest_api_latency
POST
/operations/query-tool/s3_bucket_ingestion_failures
POST
/operations/query-tool/s3_timestamps_verification
POST
/operations/query-tool/salesforce_data_sync
POST
/operations/query-tool/squashable_sum_meter_athena
POST
/operations/query-tool/stripe_flat_fee_verification
POST
/operations/query-tool/stripe_payment_verification
POST
/operations/query-tool/ultra_frequency_usage_verification
POST
/operations/query-tool/usage_monitoring
POST
/operations/query-tool/usage_sqs_statuses
POST
/operations/query-tool/usage_verification
POST
/operations/trackers/aggregator-processed-ingest-messages
POST
/operations/trackers/aoa_meters_failure
POST
/operations/trackers/commitment_validation
POST
/operations/trackers/custom_aggregation_timestamps
POST
/operations/trackers/custom_aggregation_validation
POST
/operations/trackers/customer_promotion_explain
POST
/operations/trackers/data_sync_object_counts
POST
/operations/trackers/events_filtering_validation
POST
/operations/trackers/file_search
POST
/operations/trackers/hourly_hourly_to_daily_hourly_validation
POST
/operations/trackers/invoice_explain
POST
/operations/trackers/invoice_late_arrivals_verification
POST
/operations/trackers/invoice_usage_costs_verification
POST
/operations/trackers/invoice_usage_verification
POST
/operations/trackers/item_invoice_usage_verification
POST
/operations/trackers/locked_invoice_verification
POST
/operations/trackers/long_lasting_explain
POST
/operations/trackers/long_lasting_verification
POST
/operations/trackers/marketplace_payments
POST
/operations/trackers/meter_event_dedupe
POST
/operations/trackers/platform_jobs_api
POST
/operations/trackers/prepaid_credits_verification
POST
/operations/trackers/rest_api_latency
POST
/operations/trackers/s3_bucket_ingestion_failures
POST
/operations/trackers/s3_timestamps_verification
POST
/operations/trackers/salesforce_data_sync
POST
/operations/trackers/squashable_sum_meter_athena
POST
/operations/trackers/stripe_flat_fee_verification
POST
/operations/trackers/stripe_payment_verification
POST
/operations/trackers/ultra_frequency_usage_verification
POST
/operations/trackers/usage_monitoring
POST
/operations/trackers/usage_sqs_statuses
POST
/operations/trackers/usage_verification
POST
/operations/explain
Defining Promotions
Defining Prepaid Promotions
Defining Commitments
Defining Quotes
Product Item Price Templates
Cost Item Price Templates
Defining ProductPlanTemplate
Invoices
Customer Promotions
Quote Life Cycle
Approval rules review service
Retrieving Aws Marketplace Intents
Defining Account Integration Settings
GET
Get credits ledger
POST
Query the global prepaid credits ledger
GET
Get all prepaid card invoices of a customer
GET
Get the customer credits wallet
POST
Update an external prepaid card status
GET
Get a stripe payment intent by id
POST
Create a stripe payment intent
GET
Get all stripe payment intents
POST
/payments/stripe/payment-intents/bulk
GET
/payments/stripe/payment-intents
POST
/payments/stripe/payment-intents
POST
/payments/stripe/payment-intents/batch
GET
/payments/stripe/payment-intents/list
GET
Get rewards history for a product item
GET
Get rewards history for all product items
POST
/payments/analysis/by-rule-revenue-calculator
POST
/payments/analysis/raw-revenue-calculator
POST
End a commitment
GET
Get a credit unit
POST
Create or update a credit unit
DELETE
Delete a credit unit
GET
Get an existing currency exchange rate table by id
POST
Create or update an existing currency exchange rate table
DELETE
Delete an existing, unlocked, currency exchange rate table by id
GET
Get the entire history of currency exchange rate tables
Quote the CPQ Usage Cost.
GET
Get a prepaid order
POST
Order a one time or a recurrence prepaid card by price
DELETE
Deletes a prepaid order
POST
Order a one time or a recurrence prepaid card by usage
GET
Get the entire list of open credits (orders that aren't expire yet)
POST
/payments/pricing/amberflo/customer-prepaid/void
POST
Extend the end time of the prepaid card
POST
Modify the start time for the prepaid card
POST
Modify the prepaid condition for the prepaid card
POST
Split a prepaid card into multiple prepaid cards based on the prepaid list
POST
Create a subscription
DELETE
Delete a subscription
POST
/payments/pricing/query/customer-plans
POST
/payments/pricing/query/customer-quote
GET
Get a custom promotion by id
POST
Create a custom promotion
GET
List all custom promotions
GET
Get an invoice based fee by id
POST
Create or update an invoice based fee
DELETE
Delete an invoice based fee
POST
Create or update an invoice based fee
GET
List all invoice based fees
GET
Get a prepaid offer by id
POST
Create or update a prepaid offer
DELETE
Delete a prepaid offer
GET
/payments/pricing/amberflo/account-pricing/product-item-rewards-rule
POST
/payments/pricing/amberflo/account-pricing/product-item-rewards-rule
DELETE
/payments/pricing/amberflo/account-pricing/product-item-rewards-rule
GET
/payments/pricing/amberflo/account-pricing/product-item-rewards-rule/list
POST
Extend a product plan
Commitment Cancellation
POST
/payments/pricing/amberflo/migrate-prepaid-credits
GET
/payments/settings
POST
/payments/settings
GET
Get product item by ID.
POST
Update product item.
DELETE
Delete product item by ID.
GET
List all product item objects.
GET
Get product item price by ID.
POST
Update product item price.
DELETE
Delete product item price by ID.
GET
List all product item price objects.
GET
Get product item prices by ID.
POST
Update product item prices.
DELETE
Delete product item price by ID.
GET
List all product item prices objects.
GET
Get product plan by ID.
POST
Update product plan.
DELETE
Delete product plan by ID.
GET
List all product plan objects.
GET
/payments/pricing/amberflo/entitlement
Defining approval rules
Defining Plan Catalogs
GET
Download signed quote-document
POST
Send email with quote-document to the customer
Defining Usage Transformers
Subscription Order Service
A service to manage spending limit configurations
POST
/payments/pricing/amberflo/account-pricing/detailed-dimension-matrix-node
POST
/payments/account-settings/appkeys/stripe
GET
/payments/pricing/stripe/stripe-product-details/all
GET
/payments/pricing/amberflo/customer-pricing
POST
/payments/pricing/amberflo/customer-pricing
DELETE
/payments/pricing/amberflo/customer-pricing
GET
/payments/pricing/amberflo/customer-pricing/list
GET
/payments/analysis/revenue-calculator-template
POST
/payments/analysis/revenue-calculator-template
DELETE
/payments/analysis/revenue-calculator-template
GET
/payments/analysis/revenue-calculator-template/all
GET
/payments/pricing/amberflo/account-pricing
GET
/payments/billing-settings
POST
/payments/billing-settings
DELETE
/payments/billing-settings
GET
/payments/billing-settings/list
GET
/payments/account-settings
POST
/payments/account-settings
DELETE
/payments/account-settings
GET
/payments/account-settings/list
GET
/payments/billing/settings
POST
/payments/billing/settings
GET
/payments/meter-info
Updating the Account Details.
POST
Relax prepaid conditions.
Defining custom product plans
POST
Change the CustomerProductPlan
POST
/payments/cost/usage-cost
POST
/payments/cost/usage-cost/batch
POST
/payments/cost/usage-query
POST
/payments/cost/usage-query/distribution
Customers
Feature Flag
Meter Definition
POST
/usage-aggregation/custom-aggregation-spec
GET
/usage-aggregation/custom-aggregation-spec/list
POST
/usage-aggregation/custom-aggregation
GET
/usage-aggregation/custom-aggregation/list
POST
/usage-aggregation/within-the-hour-aggregation
GET
/usage-tracker/gaps
POST
/integration/accounting/csv/invoice
POST
/integration/accounting/csv/prepaidInvoice
POST
/integration/accounting/csv/payment
POST
/integration/accounting/csv/customer
POST
Calculate the sales tax with TaxJar service.
POST
Validate an address with TaxJar service.
POST
Ping Taxjar service to validate credentials.
POST
Calculate the sales tax with Avalara service.
POST
Validate an address with Avalara service.
POST
Ping Avalara service to validate credentials.
GET
List company codes of all companies in given Avalara account.
Alert Statistics
Manage Azure Marketplace Metering Features
Manage Netsuite Features
Send contract to docusign
Download contract from docusign
Receiving envelope updates from Docusign
Access database
POST
/spark/commands
POST
/spark/query/latest-command/batch
POST
/spark/discard-commands
GET
/audit-log
GET
/audit-log/{id}
GET
/audit-log/filters
GET
/credits/balance/{customerId}
GET
/credits/top-up/options/{customerId}
DELETE
/credits/top-up/options/{customerId}
POST
/credits/top-up/options
Docs powered by
Archbee
Amberflo API
Defining Promotions
Create or update a promotion
1min
POST
https://app.amberflo.io/payments/pricing/amberflo/account-pricing/promotions/time_limited_relative_product_discount
Try it
Authentication
X-API-KEY
apiKey
Body Parameters
body
payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.in
id
string
*
type
string
promotionName
string
*
description
string
lockingStatus
com.amberflo.service.common.LockingStatus.in
targetProductId
string
promotionTimeLimit
payment.pricing.promotions.attributes.HistoryRequirements.in
discountRatio
number
totalMaxDiscount
number
cycleMaxDiscount
number
Responses
200
Successful request
payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out
id
string
*
type
string
promotionName
string
*
description
string
lockingStatus
com.amberflo.service.common.LockingStatus.out
lastUpdateTimeInMillis
integer<int64>
targetProductId
string
promotionTimeLimit
payment.pricing.promotions.attributes.HistoryRequirements.out
discountRatio
number
totalMaxDiscount
number
cycleMaxDiscount
number
PREVIOUS
Create or update a promotion
NEXT
Create or update a promotion
Docs powered by
Archbee
