Welcome
Guides
Wingback.js
Advanced
API Reference
- Introduction
- Customer
- Contract
- Billing Portal
- Entitlements
- Usage
- Payment
- Balance
- Virtual Wallets (Credits)
- Invoices
Retrieve Contract Details
curl --request GET \
--url http://127.0.0.1:8080/v1/c/contract/{contract_id} \
--header 'wb-key: <api-key>'{
"billing_information": {
"current_period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"current_period_idx": 123
},
"contract_summary": {
"activation": "2023-11-07T05:31:56Z",
"amount": "<string>",
"billing_information": {
"current_period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"current_period_idx": 123
},
"configuration": {
"automatic_payment": true,
"due_date_policy": "start_of_period",
"invoice_trigger": "immediate",
"usage_period_closing_policy": "automatic"
},
"cost_estimates": {
"custom_cycle_charges": {
"periodic_daily": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
},
"periodic_monthly": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
},
"periodic_quarterly": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
},
"periodic_weekly": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
},
"periodic_yearly": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
}
},
"on_demand_price": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
},
"one_time_price": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
},
"recurring_price": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
}
},
"created": "2023-11-07T05:31:56Z",
"currency": "usd",
"customer": "<string>",
"customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"cycle": "once",
"cycle_start_offset": 1,
"expiration": "2023-11-07T05:31:56Z",
"free_cycles": 1,
"free_trial_end": "2023-11-07T05:31:56Z",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"next_cycle_start": "2023-11-07T05:31:56Z",
"plan": "<string>",
"plan_external_name": "<string>",
"plan_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"plan_internal_name": "<string>",
"pricing_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"status": "active",
"strategy": "plan"
},
"discount": {
"amount": "<string>",
"contract_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"discount_type": "percentage",
"duration": 123,
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"name": "<string>",
"original_discount_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"slug": "<string>"
},
"plan": {
"description": "<string>",
"external_name": "<string>",
"features": [
{
"charge_trigger": "every_cycle",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"name": "<string>",
"original_feature_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"price": {
"amount": "<string>",
"currency": "usd",
"free_cycles": 1,
"strategy_details": {
"pricing_strategy": "flat"
},
"tax_code": "<string>",
"total_charge_estimate": {
"subtotal": "<string>",
"total": "<string>"
}
},
"slug": "<string>"
}
],
"free_trial_days": 1,
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"internal_name": "<string>",
"name": "<string>",
"original_plan_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"price": {
"amount": "<string>",
"currency": "usd",
"free_cycles": 1,
"strategy_details": {
"pricing_strategy": "flat"
},
"tax_code": "<string>",
"total_charge_estimate": {
"subtotal": "<string>",
"total": "<string>"
}
},
"slug": "<string>",
"strategy": "plan"
}
}Authorizations
Path Parameters
Id of the Contract
Response
Contract with additional information
Detailed information about the current billing period
Billing period of the contract. For example, for contracts that are paid monthly, a new billing period would be created each month. For Constant or Once contracts, a single period would be created with empty "end" value
Current billing period index (starting from 1, ascending)
Contract Summary
Contract estimated price
Detailed information about the current billing period
Billing period of the contract. For example, for contracts that are paid monthly, a new billing period would be created each month. For Constant or Once contracts, a single period would be created with empty "end" value
Current billing period index (starting from 1, ascending)
Additional Contract-level billing configuration
Should invoice amount be charged automatically or not
Determines when the due_date of the invoices should be set when created:
- StartOfPeriod - invoices are due at the beginning of the billing period
- EndOfPeriod - invoices are due at the end of the billing period
start_of_period, end_of_period When the invoices should be created
Note: EveryCycle and Periodic aren't yet supported, they will behave as Manual
immediate Determines how usage period should be closed:
- Automatic - usage period will be closed as soon as claim period ends
- Manual - usage period will be open until closed manually
- Delayed - automatic with delay after the claim period ends. Valid delays are 15 minutes, 1 hour, 1 day
automatic, manual, 15 minutes, 1 hour, 1 day Price estimate
Charges for features on a custom cycle
Detailed breakdown of the estimated charges
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
A supported currency
The format for parsing and reading is the lowercased ISO 4217 currency code (e.g. "usd")
usd, eur, gbp, brl, ars Customer Name
Unique identifier of an object. Consists of object class prefix and a UUID
Enum that lists supported payment cycles for contracts:
- Once - one-time payment
- Constant - one-time payment for the duration of the contract
- Week - contract is paid weekly
- Month - contract is paid monthly
- Quarter - contract is paid every quarter
- Year - contract is paid yearly
once, hour, day, week, month, quarter, year, constant The number of days from the cycle's natural start (i.e. the first day of the week/month/quarter/year) to the start of the cycles
x > 0The number of free cycles
x > 0Unique identifier of an object. Consists of object class prefix and a UUID
Plan Name
Unique identifier of an object. Consists of object class prefix and a UUID
Internal Plan name
Status of the contract:
- Active - Contract is active
- Pending - Contract is not active
- Scheduled - Contract is scheduled to activate in the future
- Canceled - Contract has been canceled
- Moved - User upgraded from this contract to a different one
- NotReady - Contract was created, but billing engine has not completed contract setup
active, pending, scheduled, canceled, moved, not_ready Pricing strategy of the Plan:
- Plan - Plan itself contains a price, and it will be used.
- Feature - Each feature in the plan is configured with a price, and final price of the plan is the combination of prices of all its features
plan, group, feature Contract Activation Date
Date os signing
Contract Expiration Date
Date of the end of the free trial, if any
End date of the current cycle (if the contract is active)
External Plan name
Unique identifier of an object. Consists of object class prefix and a UUID
Same as Plan, but attached to a Contract
List of Features present in this Plan
Same as Plan Feature, but recorded in the Contract
When the feature should be charged
every_cycle, first_cycle, on_demand, month, quarter, year Unique identifier of an object. Consists of object class prefix and a UUID
Feature Name
Unique Slug
Unique identifier of an object. Consists of object class prefix and a UUID
Information about the price of the feature in the given contract
Price
A supported currency
The format for parsing and reading is the lowercased ISO 4217 currency code (e.g. "usd")
usd, eur, gbp, brl, ars Additional details about the price that depend on the type of the price
flat Number of free cycles for this feature
x > 0Tax code
Estimated cost. Takes into account current usage and active discounts Null if calculation not performed
Number of days the plan will be free. The contract's cycles will be aligned with the end of the free trial
x > 0Unique identifier of an object. Consists of object class prefix and a UUID
Internal name of the Plan
Name of the Plan. Uses external_name if available, otherwise internal_name
Unique Slug
Pricing strategy of the Plan:
- Plan - Plan itself contains a price, and it will be used.
- Feature - Each feature in the plan is configured with a price, and final price of the plan is the combination of prices of all its features
plan, group, feature Plan Description
External name of the Plan
Unique identifier of an object. Consists of object class prefix and a UUID
Information about the price of the feature in the given contract
Price
A supported currency
The format for parsing and reading is the lowercased ISO 4217 currency code (e.g. "usd")
usd, eur, gbp, brl, ars Additional details about the price that depend on the type of the price
flat Number of free cycles for this feature
x > 0Tax code
Discount attached to a Contract
Discount amount
Unique identifier of an object. Consists of object class prefix and a UUID
Type of the discount:
- Percentage - a percent of the amount, for example 10%
- Flat - flat amount, for example $10
percentage, flat Discount Duration. This determines how many billing cycles will Discount be applied For example, for Monthly cycles, setting this value to 3 will mean that first 3 month of use will be discounted
Unique identifier of an object. Consists of object class prefix and a UUID
Discount Name
Unique slug
Unique identifier of an object. Consists of object class prefix and a UUID
curl --request GET \
--url http://127.0.0.1:8080/v1/c/contract/{contract_id} \
--header 'wb-key: <api-key>'{
"billing_information": {
"current_period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"current_period_idx": 123
},
"contract_summary": {
"activation": "2023-11-07T05:31:56Z",
"amount": "<string>",
"billing_information": {
"current_period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"current_period_idx": 123
},
"configuration": {
"automatic_payment": true,
"due_date_policy": "start_of_period",
"invoice_trigger": "immediate",
"usage_period_closing_policy": "automatic"
},
"cost_estimates": {
"custom_cycle_charges": {
"periodic_daily": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
},
"periodic_monthly": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
},
"periodic_quarterly": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
},
"periodic_weekly": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
},
"periodic_yearly": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
}
},
"on_demand_price": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
},
"one_time_price": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
},
"recurring_price": {
"cycle_start_charges": "<string>",
"extra_cycle_end_charges": "<string>",
"minimum_usage": "<string>"
}
},
"created": "2023-11-07T05:31:56Z",
"currency": "usd",
"customer": "<string>",
"customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"cycle": "once",
"cycle_start_offset": 1,
"expiration": "2023-11-07T05:31:56Z",
"free_cycles": 1,
"free_trial_end": "2023-11-07T05:31:56Z",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"next_cycle_start": "2023-11-07T05:31:56Z",
"plan": "<string>",
"plan_external_name": "<string>",
"plan_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"plan_internal_name": "<string>",
"pricing_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"status": "active",
"strategy": "plan"
},
"discount": {
"amount": "<string>",
"contract_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"discount_type": "percentage",
"duration": 123,
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"name": "<string>",
"original_discount_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"slug": "<string>"
},
"plan": {
"description": "<string>",
"external_name": "<string>",
"features": [
{
"charge_trigger": "every_cycle",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"name": "<string>",
"original_feature_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"price": {
"amount": "<string>",
"currency": "usd",
"free_cycles": 1,
"strategy_details": {
"pricing_strategy": "flat"
},
"tax_code": "<string>",
"total_charge_estimate": {
"subtotal": "<string>",
"total": "<string>"
}
},
"slug": "<string>"
}
],
"free_trial_days": 1,
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"internal_name": "<string>",
"name": "<string>",
"original_plan_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"price": {
"amount": "<string>",
"currency": "usd",
"free_cycles": 1,
"strategy_details": {
"pricing_strategy": "flat"
},
"tax_code": "<string>",
"total_charge_estimate": {
"subtotal": "<string>",
"total": "<string>"
}
},
"slug": "<string>",
"strategy": "plan"
}
}