---
title: "Subscription"
method: POST
path: "/v1.02/creditcard/subscription"
---

# Subscription

`POST /v1.02/creditcard/subscription`

## Request

- Base URL: `https://sandbox.eupago.pt/api`
- URL: `https://sandbox.eupago.pt/api/v1.02/creditcard/subscription`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/eupago/apis/rest-api-apikey-auth/docs/v1.02/creditcard/subscription/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates an url to a secure form where the customer may finish the Credit Card subscription. Supports 3D Secure Technology.

## Request body

- object
  - `payment` object, required
    - `identifier` string
    - `amount` object
      - `value` integer
      - `currency` string
    - `subscription` object
      - `date` string: Format YYYY-MM-DD
      - `autoProcess` '0' | '1': Defines if the debit will processed by the API automatically (1) or there will be a manual debit instruction (0).
      - `collectionDay` integer: Mandatory if it is defined a periodicity and it's auto process is true.
      - `periodicity` 'Semanal' | 'Quinzenal' | 'Mensal' | 'Trimestral' | 'Semestral' | 'Anual'
      - `limitDate` string: Date (YYYY-MM-DD) defined to be the last debit for this Authorization
      - `customer` object
        - `notify` boolean, required
        - `email` string, required: Customer's email
    - `successUrl` string
    - `failUrl` string
    - `backUrl` string
  - `customer` object
    - `notify` boolean
    - `email` string: Customer's email

## Response `200`

200

- object
  - `transactionStatus` string
  - `statusSubs` string
  - `subscriptionID` string
  - `referenceSubs` string
  - `redirectUrl` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/eupago/apis/rest-api-apikey-auth.md) - [All operations](https://skmtc.dev/eupago/apis/rest-api-apikey-auth/llms.txt) - [OpenAPI document](https://skmtc.dev/eupago/apis/rest-api-apikey-auth/revisions/a8c2e94702a4?raw)