Get a specific subscription

GET 
/api/v3/package/:package_id

Request

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response object

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {}
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "terms_id": 2,
    "class_id": null,
    "admin_id": 3,
    "currency_id": 1,
    "brand_id": 1,
    "external_key": null,
    "token": "1tk5j5u2efhi",
    "nickname": "",
    "paymethod": "inv",
    "paycycle": "mon",
    "bill_addr1": null,
    "bill_addr2": null,
    "bill_addr3": null,
    "bill_city": null,
    "bill_state": null,
    "bill_postcode": null,
    "bill_country": null,
    "bill_notes": null,
    "ship_addr1": null,
    "ship_addr2": null,
    "ship_addr3": null,
    "ship_city": null,
    "ship_state": null,
    "ship_postcode": null,
    "ship_country": null,
    "ship_notes": null,
    "creditcard_id": null,
    "ach_id": null,
    "tokenized_id": null,
    "custom_1": null,
    "custom_2": null,
    "custom_3": null,
    "custom_4": null,
    "custom_5": null,
    "write_datetime": "2017-09-20 12:33:44",
    "mod_datetime": "2017-09-20 12:33:44",
    "start_datetime": "2017-09-20 12:33:44",
    "suspendfrom_datetime": null,
    "suspendto_datetime": null,
    "cancel_datetime": null,
    "holduntil_datetime": null,
    "terms_name": "Net 30",
    "terms_days": 30,
    "currency_symbol": "$",
    "currency_iso4217": "USD",
    "amount_collected": 0,
    "amount_invoiced": 250,
    "amount_due": 250,
    "is_overdue": false,
    "days_overdue": 0,
    "next_invoice_datetime": "2017-10-20 00:00:01",
    "cancel_reason": null,
    "url_self": "http://dev.chargeover.com/admin/r/package/view/21",
    "package_id": 21,
    "customer_id": 22,
    "package_status_id": 2,
    "package_status_name": "Current",
    "package_status_str": "active-current",
    "package_status_state": "a",
    "line_items": [
      {
        "item_id": 254,
        "tierset_id": 16,
        "admin_id": null,
        "external_key": null,
        "nickname": "",
        "descrip": null,
        "line_quantity": 1,
        "trial_days": 0,
        "trial_recurs": "0",
        "trial_units": 0,
        "custom_1": null,
        "custom_2": null,
        "custom_3": null,
        "subscribe_datetime": "2017-09-20 12:33:44",
        "subscribe_prorate_from_datetime": null,
        "subscribe_prorate_to_datetime": null,
        "cancel_datetime": null,
        "expire_datetime": null,
        "expire_recurs": null,
        "item_name": "Premium Silver",
        "item_external_key": null,
        "item_accounting_sku": null,
        "item_token": "8225neo3wmp4",
        "item_type": "service",
        "item_units": null,
        "item_is_usage": false,
        "line_item_id": 23,
        "package_id": 21,
        "tierset": {
          "tierset_id": 16,
          "currency_id": 1,
          "setup": 0,
          "base": 250,
          "percent": 0,
          "paycycle": "evy",
          "pricemodel": "fla",
          "write_datetime": "2017-09-20 12:29:32",
          "mod_datetime": "2017-09-20 12:29:32",
          "currency_symbol": "$",
          "currency_iso4217": "USD",
          "setup_formatted": "$ 0.00",
          "base_formatted": "$ 250.00",
          "percent_formatted": "0 %",
          "pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
          "tiers": []
        }
      }
    ]
  }
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...