GEgetswipe
Subscriptions V2

List of subscriptions

Changed on

Lists subscriptions within a required date range, filterable by status and customer_id. Subscriptions are created through Create a document with document_type=subscription.

get/v2/subscriptions/list

Request

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

Query parameters

start_datestring required

Start date for the list, [DD-MM-YYYY]

end_datestring required

End date for the list, [DD-MM-YYYY]

status'all' | 'active' | 'expired' | 'error' | 'cancelled'

Filter list based on status of the document

num_recordsstring

Number of records to fetch(max 100)

pageinteger

Page number

customer_idstring

Customer ID

Response

Subscription List fetched successfully

successboolean

Success flag

messagestring

Message

error_codestring

Error code

errorsobject

Error details

Example response

{
  "success": true,
  "message": "Details Fetched",
  "data": {
    "transactions": [
      {
        "customer_id": "Cust123",
        "customer_name": "CUST123",
        "subscription_date": "10 June 2024",
        "subscription_start_time": "10 June 2024",
        "subscription_end_time": "10 Aug 2024",
        "sub_serial_number": "SUB-123",
        "repeat_every": 1,
        "repeat_unit": "months",
        "status": "active",
        "invoice_count": 1,
        "invoices": [
          {
            "name": "CUST123",
            "id": "Cust123",
            "serial_number": "INV-123",
            "status": "active",
            "hash_id": "SUB123",
            "record_time": "10 June 2024",
            "total_amount": 1000
          }
        ],
        "last_created_invoice": "10 June 2024",
        "upcoming_date": "10 June 2024",
        "hash_id": "SUB123",
        "total_amount": 1000
      }
    ],
    "total_records": 10
  }
}

Changes

  • 0bcdbc62187bRevision changes
    • breaking

      for the query request parameter customer_id, default value was added

    • breaking

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

    • info

      api operation id v2_get_subscriptions removed and replaced with get_transactions