Contract
Retrieve Contract Details
Welcome
Guides
Wingback.js
Advanced
API Reference
- Introduction
- Customer
- Contract
- Billing Portal
- Entitlements
- Usage
- Payment
- Balance
- Virtual Wallets (Credits)
- Invoices
Contract
Retrieve Contract Details
GET
/
v1
/
c
/
contract
/
{contract_id}
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
200 - application/json
Contract Details
Contract with additional information
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"
}
}