Find a specific subscription

GET 
/recurrency/subscriptions/:subscriptionId

This endpoint is used to retrieve the details of a specific subscription based on the provided ID. Upon accessing this endpoint, the system returns the full subscription details, including the associated plan, customer, status, start date, end date, and any other relevant details.

Request

Path Parameters

subscriptionId uuidrequired
Example: 8086bfd7-6241-4f76-81d8-70460533ce74

Responses

200

OK

application/json

Schema

Schema

name string
email string
startDate date-time
endDate date-time
amount int32
isActive boolean

card

object

cardNumber string

brandName string

cardholderName string

expirationMonth int32

expirationYear int32

charges

object[]

Array [

id uuid

status string

chargedAt date-time

amount int32

]

plan

object

id string

billingCycle string

totalBillingCycles int32

initialGraceCycles int32

initialFee

object

description string

amount int32

cycles int32

tag string

paymentType string

amount int32

enabled boolean

Indicates if the plan is enabled or not.

traceKey uuid

Example (from schema)

{
  "name": "Betina Stefany Gabrielly Nunes",
  "email": "betinastefanygabriellynunes@br.pwc.com",
  "startDate": "2021-07-13T00:00:00",
  "endDate": "2021-08-12T00:00:00",
  "amount": 1000,
  "isActive": true,
  "card": {
    "cardNumber": "411111******1111",
    "brandName": "Visa",
    "cardholderName": "Betina Stefany Gabrielly Nunes",
    "expirationMonth": 12,
    "expirationYear": 2026
  },
  "charges": [
    {
      "id": "g9e58745-7895-1235-9632-c782d0999b7c",
      "status": "Autorizada",
      "chargedAt": "2021-07-03T19:40:03.322",
      "amount": 1000
    }
  ],
  "plan": {
    "id": "string",
    "billingCycle": "string",
    "totalBillingCycles": 0,
    "initialGraceCycles": 0,
    "initialFee": {
      "description": "Fee test description",
      "amount": 25,
      "cycles": 10
    },
    "tag": "string",
    "paymentType": "string",
    "amount": 15,
    "enabled": false
  },
  "traceKey": "d4d39add-c875-4855-95c8-6f5de388aa53"
}

400

Bad Request

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Authorization token not found.",
  "success": false,
  "errors": {
    "message": "Authorization token not found",
    "field": "Authorization Token"
  }
}

415

Unsupported Media Type

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Request object is invalid or incorrectly formatted",
  "success": false,
  "errors": null
}

500

Internal Server Error

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Internal Server Error",
  "success": false,
  "errors": null
}

502

Bad Gateway

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Internal Server Error",
  "success": false,
  "errors": null
}

Loading...