# Get subscription

Use it to get subscription

Endpoint: GET /subscriptions/{subscriptionId}
Version: 1.0

## Path parameters:

  - `subscriptionId` (string, required)

## Header parameters:

  - `x-api-key` (string, required)
    Api key provided on integrations tab in Easyflow platform.

  - `x-api-secret` (string, required)
    Api Secret provided on integrations tab in Easyflow platform.

## Response 200 fields (application/json):

  - `statusCode` (integer)
    Example: 200

  - `data` (object)

  - `data.id` (string)

  - `data.name` (string)

  - `data.subscribedAt` (string)

  - `data.periodicity` (string)

  - `data.numberRecurrences` (integer)

  - `data.status` (string)
    status returning: active, inactive, canceled, expired

  - `data.subscriptionPaymentStatus` (string)
    status returning: canceled, pending, failed, delayed, paid

  - `data.customer` (object)

  - `data.customer.email` (string)

  - `data.customer.phone` (object)

  - `data.customer.phone.areaCode` (string)

  - `data.customer.phone.ddd` (string)

  - `data.customer.phone.number` (string)

  - `data.customer.phone.isMobile` (boolean)

  - `data.customer.billingAddress` (object)

  - `data.customer.billingAddress.zipCode` (string,null)

  - `data.customer.billingAddress.street` (string,null)

  - `data.customer.billingAddress.complement` (string,null)

  - `data.customer.billingAddress.neighborhood` (string,null)

  - `data.customer.billingAddress.city` (string,null)

  - `data.customer.billingAddress.state` (string,null)

  - `data.customer.deliveryAddress` (object)

  - `data.customer.document` (object)

  - `data.customer.document.type` (string)

  - `data.customer.userId` (string)

  - `data.customer.externalReferenceId` (string)

  - `data.orderItem` (object)

  - `data.orderItem.product` (object)

  - `data.orderItem.product.businessId` (string)

  - `data.orderItem.unitValueInCents` (integer)

  - `data.orderItem.quantity` (integer)

  - `data.recurrenceValueInCents` (integer)

  - `data.expiration` (string,null)

  - `data.paymentMethod` (string)

  - `data.creditCard` (object)

  - `data.creditCard.nickname` (string,null)

  - `data.creditCard.last4Numbers` (string)

  - `data.creditCard.holderName` (string)

  - `data.creditCard.expiresAtMonth` (integer)

  - `data.creditCard.expiresAtYear` (integer)

  - `data.creditCard.flag` (string)

  - `data.repeatIndefinitely` (boolean)

  - `data.customValue` (object)

  - `data.customValue.recurrenceFrom` (integer)

  - `data.customValue.recurrenceTo` (integer)

  - `data.customValue.valueInCents` (integer)

  - `data.recurrences` (array)

  - `data.recurrences.recurrence` (integer)

  - `data.recurrences.billingDate` (string)

  - `data.recurrences.dueDate` (string)

  - `data.recurrences.paidAt` (string)

  - `data.recurrences.status` (string)

  - `data.recurrences.payments` (array)

  - `data.recurrences.payments.valuePaidInCents` (integer)

  - `data.recurrences.payments.externalId` (string,null)

  - `data.recurrences.payments.fineValueInCents` (integer)

  - `data.recurrences.payments.installments` (integer)

  - `data.recurrences.payments.interestValueInCents` (integer)

## Response 400 fields (application/json):

  - `message` (string)
    Invalid param: []
    Example: "Invalid param: []"

  - `error` (string)
    Bad Request
    Example: "Bad Request"

  - `statusCode` (integer)
    400
    Example: 400

## Response 401 fields (application/json):

  - `message` (string)
    Invalid field
    Example: "Unauthorized"

  - `error` (string)
    Unauthorized
    Example: "Unauthorized"

  - `statusCode` (integer)
    401
    Example: 401

## Response 403 fields (application/json):

  - `message` (string)
    Forbidden resource
    Example: "Forbidden resource"

  - `error` (string)
    Forbidden
    Example: "Forbidden"

  - `statusCode` (integer)
    403
    Example: 403

## Response 500 fields (application/json):

  - `message` (string)
    Internal server error
    Example: "Internal server error"

  - `error` (string)
    Internal Server Error
    Example: "Internal Server Error"

  - `statusCode` (integer)
    500
    Example: 500