get
https://app.bill.pro/api/v1/orders/
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Get any type of order by the order number.
The BillPro API will return an order object for the order type so the response data may vary by order type.
This table provides some general notes about the attributes in the response to the Get Order request.
Single payment order
| Attribute | Description |
|---|---|
| id | The unique system identifier of the order |
| profile_id | Merchant profile ID |
| order_type | One of the purchase types of single_payment, instalment, subscripton, or metered. See Purchase types |
| status | See Order status |
| invoice_id | Your merchant identifier of the order |
| customer_id | The unique system identifier of the customer. In the customer object, this is the id. |
| monthly_amount | Scheduled payment amount. |
| scheduled_duration_unit | For instalment payments or scheduled payments. Values can be DAY, WEEK, MONTH and YEAR. |
| scheduled_duration_number | For an instalment order, the number of scheduled payments |
| total_to_pay | For an instalment order, the total amount of the order, including the initial payment. |
| count_to_pay | For instalment order, the total number of payments, including any initial payment and instalments. |
| description | When you create an order with the API, you can enter a description. |
| profile_payment_method | ECOM or MOTO for payment link or virtual terminal. This is channel for the initial payment. |
| order_source | For UI, the value is 1. For API, the value is 2 |
| collect_initial_payment | If BillPro collects a deposit, thentrue, otherwise false. |
| total_installment_amount | For an instalment order, this is the total amount including the deposit. Note that the spelling is `installmentz. |
| total_discount_amount | Total of the discounts applied to the products in a single payment order with multiple products |
| total_tax_amount | Total of the taxes applied to the products in a single payment order |
| total_fee_amount | Total of the fees applied to the products in a single payment order |
| products | For a single-payment order: a list of products. For an instalment order, a single product. |
| products.product or product | For a single-payment order: a product in a list. |
| product.subtotal_amount | The subtotal of the product price multiplied by the quantity with fees and discounts applied |
| customer.phone | The mobile phone number of the customer, including the + symbol, the country code, and the phone number |
Instalment order
| Attribute | Description |
|---|---|
| id | The unique system identifier of the order |
| profile_id | Merchant profile ID |
| order_type | One of the purchase types of single_payment, instalment, subscripton, or metered. See Purchase types |
| status | See Order status |
| invoice_id | Your merchant identifier of the order |
| customer_id | The unique system identifier of the customer. In the customer object, this is the id. |
| monthly_amount | Scheduled payment amount. |
| scheduled_duration_unit | For instalment payments or scheduled payments. Values can be DAY, WEEK, MONTH and YEAR. |
| scheduled_duration_number | For an instalment order, the number of scheduled payments |
| total_to_pay | For an instalment order, the total amount of the order, including the initial payment. |
| count_to_pay | For instalment order, the total number of payments, including any initial payment and instalments. |
| description | When you create an order with the API, you can enter a description. |
| profile_payment_method | ECOM or MOTO for payment link or virtual terminal. This is channel for the initial payment. |
| order_source | For UI, the value is 1. For API, the value is 2 |
| collect_initial_payment | If BillPro collects a deposit, thentrue, otherwise false. |
| total_installment_amount | For an instalment order, this is the total amount including the deposit. Note that the spelling is `installmentz. |
| total_discount_amount | Total of the discounts applied to the products in a single payment order with multiple products |
| total_tax_amount | Total of the taxes applied to the products in a single payment order |
| total_fee_amount | Total of the fees applied to the products in a single payment order |
| products | For a single-payment order: a list of products. For an instalment order, a single product. |
| products.product or product | For a single-payment order: a product in a list. |
| product.subtotal_amount | The subtotal of the product price multiplied by the quantity with fees and discounts applied |
| customer.phone | The mobile phone number of the customer, including the + symbol, the country code, and the phone number |
Subscription order
| Attribute | Description |
|---|---|
| id | The unique system identifier of the order |
| profile_id | Merchant profile ID |
| order_type | One of the purchase types of single_payment, instalment, subscripton, or metered. See Purchase types |
| status | See Order status |
| invoice_id | Your merchant identifier of the order |
| customer_id | The unique system identifier of the customer. In the customer object, this is the id. |
| monthly_amount | Scheduled payment amount. |
| scheduled_duration_unit | For instalment payments or scheduled payments. Values can be DAY, WEEK, MONTH and YEAR. |
| scheduled_duration_number | For an instalment order, the number of scheduled payments |
| total_to_pay | For an instalment order, the total amount of the order, including the initial payment. |
| count_to_pay | For instalment order, the total number of payments, including any initial payment and instalments. |
| description | When you create an order with the API, you can enter a description. |
| profile_payment_method | ECOM or MOTO for payment link or virtual terminal. This is channel for the initial payment. |
| order_source | For UI, the value is 1. For API, the value is 2 |
| collect_initial_payment | If BillPro collects a deposit, thentrue, otherwise false. |
| total_installment_amount | For an instalment order, this is the total amount including the deposit. Note that the spelling is `installmentz. |
| total_discount_amount | Total of the discounts applied to the products in a single payment order with multiple products |
| total_tax_amount | Total of the taxes applied to the products in a single payment order |
| total_fee_amount | Total of the fees applied to the products in a single payment order |
| products | For a single-payment order: a list of products. For an instalment order, a single product. |
| products.product or product | For a single-payment order: a product in a list. |
| product.subtotal_amount | The subtotal of the product price multiplied by the quantity with fees and discounts applied |
| customer.phone | The mobile phone number of the customer, including the + symbol, the country code, and the phone number |
Metered Order
| Attribute | Description |
|---|---|
| id | The unique system identifier of the order |
| profile_id | Merchant profile ID |
| order_type | metered. See Purchase types |
| status | See Order status |
| invoice_id | Your merchant identifier of the order |
| customer_id | The unique system identifier of the customer. In the customer object, this is the id. |
| monthly_amount | Scheduled payment amount. |
| scheduled_duration_unit | For instalment payments or scheduled payments. Values can be DAY, WEEK, MONTH and YEAR. |
| scheduled_duration_number | For an instalment order, the number of scheduled payments |
| total_to_pay | For an instalment order, the total amount of the order, including the initial payment. |
| count_to_pay | For instalment order, the total number of payments, including any initial payment and instalments. |
| description | When you create an order with the API, you can enter a description. |
| profile_payment_method | ECOM or MOTO for payment link or virtual terminal. This is channel for the initial payment. |
| order_source | For UI, the value is 1. For API, the value is 2 |
| collect_initial_payment | If BillPro collects a deposit, thentrue, otherwise false. |
| total_installment_amount | For an instalment order, this is the total amount including the deposit. Note that the spelling is `installmentz. |
| total_discount_amount | Total of the discounts applied to the products in a single payment order with multiple products |
| total_tax_amount | Total of the taxes applied to the product |
| total_fee_amount | Total of the fees applied to the product |
| products | For a metered order, a single product. |
| products.product or product | For a single-payment order: a product in a list. |
| product.subtotal_amount | The subtotal of the product price multiplied by the quantity with fees and discounts applied |
| customer.phone | The mobile phone number of the customer, including the + symbol, the country code, and the phone number |