Get a Subscription

GET

/subscriptions/

const url = 'http://pay.caspeco.net/subscriptions/';
const options = {
  method: 'GET',
  headers: {
    Location: 'http://pay.caspeco.net/v1/subscriptions/',
    Host: 'pay.caspeco.net',
    Date: 'Tue, 15 Nov 2014 08:12:31 GMT',
    Digest: 'SHA-256=7oaYBB1oQVPy1BvP2ndYtxdD5EWNynt9lxCHzOdXb1A=',
    'Content-Type': 'application/json'
  },
  body: '{"Id":"12923"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://pay.caspeco.net/subscriptions/ \
  --header 'Content-Type: application/json' \
  --header 'Date: Tue, 15 Nov 2014 08:12:31 GMT' \
  --header 'Digest: SHA-256=7oaYBB1oQVPy1BvP2ndYtxdD5EWNynt9lxCHzOdXb1A=' \
  --header 'Host: pay.caspeco.net' \
  --header 'Location: http://pay.caspeco.net/v1/subscriptions/' \
  --data '{ "Id": "12923" }'

Get subscription status and details. If the subscription plan is not registered, a 404 Not Found is returned.

Parameters

Header Parameters

Location

string

E.g. http://pay.caspeco.net/v1/subscriptions/

Example

http://pay.caspeco.net/v1/subscriptions/

Host

string

E.g. pay.caspeco.net

Example

pay.caspeco.net

Date

string

E.g. Tue, 15 Nov 2014 08:12:31 GMT

Example

Tue, 15 Nov 2014 08:12:31 GMT

Digest

string

E.g. SHA-256=7oaYBB1oQVPy1BvP2ndYtxdD5EWNynt9lxCHzOdXb1A=

Example

SHA-256=7oaYBB1oQVPy1BvP2ndYtxdD5EWNynt9lxCHzOdXb1A=

Request Body

application/json

object

string

Example

{
  "Id": "12923"
}

Responses

200

application/json

object

MerchantId

integer

SubscriptionId

string

Charges

Array<object>

object

string

Captured

boolean

Refunded

boolean

Amount

decimal

Currency

string

Merchant

integer

Customer

string

Order

string

OrderDescription

string

CreatedDate

string

LastCharge

string

NextCharge

string

Status

string

OrderNumber

string

Examples

response

{
  "MerchantId": 12923,
  "SubscriptionId": "b87ca816-cbe2-47c3-9b01-d90a8a88f770",
  "Charges": [
    {
      "Id": "aaa111",
      "Captured": true,
      "Refunded": false,
      "Amount": 10000,
      "Currency": "SEK",
      "Merchant": 1234,
      "Customer": "9d211740",
      "Order": "ABC123",
      "OrderDescription": "Silverpaketet"
    }
  ],
  "CreatedDate": "2016-01-01",
  "LastCharge": "2016-01-02",
  "NextCharge": "2016-01-10",
  "Status": "Active",
  "OrderNumber": "12312300"
}