QorePay - Api Documentation

Retrieve a billing template by ID

GET

https://gate.qorepay.com/api/v1/billing_templates/{id}

HEADER PARAMS

authorization

String

required
Set value to BEARER SECRET_KEY

content-type

String

required
Set value to JSON

PATH PARAMS

id

string

required
ID associated with the billing template.

RESPONSES

200

OK

Query

Javascript


  const options = {
    method: 'PUT',
    headers: {
      accept: 'application/json'
    }
  };

  fetch('https://gate.qorepay.com/api/v1/billing_templates/{id}', options)
    .then(response => response.json())
    .then(response => console.log(response))
    .catch(err => console.error(err));

Sample Response

JSON


{
  "type": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_on": 1619740800,
  "updated_on": 1619740800,
  "purchase": {
    "currency": "str",
    "products": [
      {
        "name": "string",
        "quantity": "1",
        "price": 0,
        "discount": 0,
        "tax_percent": "0",
        "category": "string"
      }
    ],
    "total": 0,
    "language": "en",
    "notes": "string",
    "debt": 0,
    "subtotal_override": null,
    "total_tax_override": null,
    "total_discount_override": null,
    "total_override": null,
    "request_client_details": [],
    "timezone": "Europe/Oslo",
    "due_strict": false,
    "email_message": "string"
  },
  "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "number_of_billing_cycles": 0,
  "is_test": true,
  "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "is_subscription": true,
  "invoice_issued": "2020-04-30",
  "invoice_due": 1619740800,
  "invoice_skip_capture": false,
  "invoice_send_receipt": false,
  "subscription_period": 1,
  "subscription_period_units": "months",
  "subscription_due_period": 7,
  "subscription_due_period_units": "days",
  "subscription_charge_period_end": false,
  "subscription_trial_periods": 0,
  "subscription_active": false,
  "subscription_has_active_clients": true,
  "force_recurring": false, 
}