GEgetswipe
Subscriptions V2

Get subscription details

Changed on

Returns one subscription's details, including the invoices generated from it so far.

get/v2/subscriptions/{subscription_hash_id}

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v2/subscriptions/{subscription_hash_id}
  • Auth
    HTTP bearer

Query parameters

num_recordsstring

Number of records to fetch(max 100)

pageinteger

Page number

Response

Subscription fetched successfully

successboolean

Success flag

messagestring

Message

error_codestring

Error code

errorsobject

Error details

Example response

{
  "success": true,
  "message": "Details Fetched",
  "data": {
    "invoices": [
      {
        "name": "CUST123",
        "id": "Cust123",
        "serial_number": "INV-123",
        "status": "active",
        "hash_id": "SUB123",
        "record_time": "10 June 2024",
        "total_amount": 1000
      }
    ],
    "upcoming_date": "10 June 2024",
    "repeat_every": 1,
    "repeat_unit": "months",
    "last_created": "10 June 2024",
    "total_records": 10
  }
}

Changes

  • 0bcdbc62187bRevision changes
    • breaking

      for the query request parameter num_records, default value was changed from 10 to 10

    • warning

      deleted the path request parameter subscription_hash_id

    • info

      api operation id v2_get_subscription removed and replaced with get_subscription