Recuperar detalhes de assinatura

curl --request GET \
  --url https://api.malga.io/v1/subscriptions/{id} \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>'

const options = {method: 'GET', headers: {'X-Client-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.malga.io/v1/subscriptions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.malga.io/v1/subscriptions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Client-Id", "<api-key>")
	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "abecf6d6-153e-4fc9-8222-8be5441de581",
  "name": "Assinatura Premium com Eventos",
  "clientId": "567265cb-fa7f-419f-9c1c-8e878dd2faf7",
  "merchantId": "90d64a51-d442-426c-bbf9-b66e000e5576",
  "customerId": "b99e159e-27d5-4927-b46e-ae7348f20131",
  "referenceKey": "SUB-PREMIUM-001",
  "currency": "BRL",
  "items": [
    {
      "name": "Ingresso VIP Mensal",
      "amount": 29900,
      "quantity": 1,
      "description": "Acesso VIP premium a eventos mensais",
      "sku": "VIP-EVENT-001",
      "risk": "Low",
      "categoryId": "entertainment",
      "locality": "São Paulo",
      "date": "2025-12-01",
      "type": 1,
      "genre": "Shows e Eventos",
      "tickets": {
        "quantityTicketSale": 1,
        "quantityEventHouse": 0,
        "convenienceFeeValue": 15.5,
        "quantityFull": 1,
        "quantityHalf": 0,
        "batch": 1
      },
      "location": {
        "street": "Av. Paulista",
        "number": "1000",
        "complement": "Centro de Convenções",
        "zipCode": "01310-100",
        "city": "São Paulo",
        "state": "SP",
        "country": "Brasil",
        "district": "Bela Vista",
        "reference": "Próximo ao MASP"
      }
    }
  ],
  "recurrence": {
    "interval": "monthly",
    "cycles": 12,
    "startAt": "2025-08-10",
    "endAt": "2026-08-10",
    "nextDueDate": "2025-07-30"
  },
  "paymentMethod": {
    "type": "credit",
    "card": {
      "cardId": "bfb60d16-108c-440b-bdb8-bbe67140f936"
    },
    "installments": 1
  },
  "trial": {
    "endDate": "2025-08-15"
  },
  "splitRules": [
    {
      "sellerId": "d98106e8-568a-44c3-94d0-0e0bbd8b7e08",
      "percentage": 70,
      "processingFee": false,
      "chargeEntireFee": false,
      "chargeRemainderFee": false,
      "liable": true,
      "fares": {
        "mdr": 2.5,
        "fee": 0.3
      }
    }
  ],
  "status": "created",
  "amount": 29900,
  "liveMode": true,
  "lastCycle": {
    "id": "ae765755-c909-4d97-813c-9c71add4b182",
    "customerId": "b99e159e-27d5-4927-b46e-ae7348f20131",
    "merchantId": "90d64a51-d442-426c-bbf9-b66e000e5576",
    "cycle": 1,
    "attempts": 1,
    "status": "authorized",
    "amount": 29900,
    "items": [
      {
        "name": "Ingresso VIP Mensal",
        "amount": 29900,
        "quantity": 1,
        "description": "Acesso VIP premium a eventos mensais",
        "sku": "VIP-EVENT-001",
        "risk": "Low",
        "categoryId": "entertainment",
        "locality": "São Paulo",
        "date": "2025-12-01",
        "type": 1,
        "genre": "Shows e Eventos",
        "tickets": {
          "quantityTicketSale": 1,
          "quantityEventHouse": 0,
          "convenienceFeeValue": 15.5,
          "quantityFull": 1,
          "quantityHalf": 0,
          "batch": 1
        },
        "location": {
          "street": "Av. Paulista",
          "number": "1000",
          "complement": "Centro de Convenções",
          "zipCode": "01310-100",
          "city": "São Paulo",
          "state": "SP",
          "country": "Brasil",
          "district": "Bela Vista",
          "reference": "Próximo ao MASP"
        }
      }
    ],
    "scheduledAt": "2025-07-30",
    "executedAt": "2025-07-30",
    "nextAttemptAt": "2025-07-31",
    "isEmulated": false,
    "emulatedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2025-07-30T20:14:12.599715Z",
    "paymentHistory": [
      {
        "id": "f9661d7d-92fc-468a-8223-bc51f2ce8661",
        "createdAt": "2025-07-30T20:14:12.608115Z",
        "executedAt": "2025-07-30T20:14:13.104331Z",
        "chargeId": "e17e09a4-5d0c-40c6-a8c0-be2adc765608",
        "attemptNumber": 1,
        "status": "authorized",
        "paymentMethod": {
          "type": "credit",
          "card": {
            "cardId": "bfb60d16-108c-440b-bdb8-bbe67140f936"
          },
          "installments": 1
        },
        "error": {
          "message": "Card declined",
          "providerError": {
            "declinedCode": "insufficient_funds",
            "message": "<string>",
            "networkDeniedMessage": "<string>",
            "networkDeniedReason": "<string>",
            "retryable": true
          }
        }
      }
    ]
  },
  "createdAt": "2025-07-31T13:36:40.118822Z",
  "updatedAt": "2025-07-31T13:36:40.118822Z",
  "cancelAtPeriodEnd": true,
  "scheduledCancellationAt": "2025-12-31",
  "scheduledCancellationReason": "Cliente solicitou cancelamento"
}

GET

subscriptions

{id}

Recuperar detalhes de assinatura

curl --request GET \
  --url https://api.malga.io/v1/subscriptions/{id} \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>'

const options = {method: 'GET', headers: {'X-Client-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.malga.io/v1/subscriptions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.malga.io/v1/subscriptions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Client-Id", "<api-key>")
	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "abecf6d6-153e-4fc9-8222-8be5441de581",
  "name": "Assinatura Premium com Eventos",
  "clientId": "567265cb-fa7f-419f-9c1c-8e878dd2faf7",
  "merchantId": "90d64a51-d442-426c-bbf9-b66e000e5576",
  "customerId": "b99e159e-27d5-4927-b46e-ae7348f20131",
  "referenceKey": "SUB-PREMIUM-001",
  "currency": "BRL",
  "items": [
    {
      "name": "Ingresso VIP Mensal",
      "amount": 29900,
      "quantity": 1,
      "description": "Acesso VIP premium a eventos mensais",
      "sku": "VIP-EVENT-001",
      "risk": "Low",
      "categoryId": "entertainment",
      "locality": "São Paulo",
      "date": "2025-12-01",
      "type": 1,
      "genre": "Shows e Eventos",
      "tickets": {
        "quantityTicketSale": 1,
        "quantityEventHouse": 0,
        "convenienceFeeValue": 15.5,
        "quantityFull": 1,
        "quantityHalf": 0,
        "batch": 1
      },
      "location": {
        "street": "Av. Paulista",
        "number": "1000",
        "complement": "Centro de Convenções",
        "zipCode": "01310-100",
        "city": "São Paulo",
        "state": "SP",
        "country": "Brasil",
        "district": "Bela Vista",
        "reference": "Próximo ao MASP"
      }
    }
  ],
  "recurrence": {
    "interval": "monthly",
    "cycles": 12,
    "startAt": "2025-08-10",
    "endAt": "2026-08-10",
    "nextDueDate": "2025-07-30"
  },
  "paymentMethod": {
    "type": "credit",
    "card": {
      "cardId": "bfb60d16-108c-440b-bdb8-bbe67140f936"
    },
    "installments": 1
  },
  "trial": {
    "endDate": "2025-08-15"
  },
  "splitRules": [
    {
      "sellerId": "d98106e8-568a-44c3-94d0-0e0bbd8b7e08",
      "percentage": 70,
      "processingFee": false,
      "chargeEntireFee": false,
      "chargeRemainderFee": false,
      "liable": true,
      "fares": {
        "mdr": 2.5,
        "fee": 0.3
      }
    }
  ],
  "status": "created",
  "amount": 29900,
  "liveMode": true,
  "lastCycle": {
    "id": "ae765755-c909-4d97-813c-9c71add4b182",
    "customerId": "b99e159e-27d5-4927-b46e-ae7348f20131",
    "merchantId": "90d64a51-d442-426c-bbf9-b66e000e5576",
    "cycle": 1,
    "attempts": 1,
    "status": "authorized",
    "amount": 29900,
    "items": [
      {
        "name": "Ingresso VIP Mensal",
        "amount": 29900,
        "quantity": 1,
        "description": "Acesso VIP premium a eventos mensais",
        "sku": "VIP-EVENT-001",
        "risk": "Low",
        "categoryId": "entertainment",
        "locality": "São Paulo",
        "date": "2025-12-01",
        "type": 1,
        "genre": "Shows e Eventos",
        "tickets": {
          "quantityTicketSale": 1,
          "quantityEventHouse": 0,
          "convenienceFeeValue": 15.5,
          "quantityFull": 1,
          "quantityHalf": 0,
          "batch": 1
        },
        "location": {
          "street": "Av. Paulista",
          "number": "1000",
          "complement": "Centro de Convenções",
          "zipCode": "01310-100",
          "city": "São Paulo",
          "state": "SP",
          "country": "Brasil",
          "district": "Bela Vista",
          "reference": "Próximo ao MASP"
        }
      }
    ],
    "scheduledAt": "2025-07-30",
    "executedAt": "2025-07-30",
    "nextAttemptAt": "2025-07-31",
    "isEmulated": false,
    "emulatedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2025-07-30T20:14:12.599715Z",
    "paymentHistory": [
      {
        "id": "f9661d7d-92fc-468a-8223-bc51f2ce8661",
        "createdAt": "2025-07-30T20:14:12.608115Z",
        "executedAt": "2025-07-30T20:14:13.104331Z",
        "chargeId": "e17e09a4-5d0c-40c6-a8c0-be2adc765608",
        "attemptNumber": 1,
        "status": "authorized",
        "paymentMethod": {
          "type": "credit",
          "card": {
            "cardId": "bfb60d16-108c-440b-bdb8-bbe67140f936"
          },
          "installments": 1
        },
        "error": {
          "message": "Card declined",
          "providerError": {
            "declinedCode": "insufficient_funds",
            "message": "<string>",
            "networkDeniedMessage": "<string>",
            "networkDeniedReason": "<string>",
            "retryable": true
          }
        }
      }
    ]
  },
  "createdAt": "2025-07-31T13:36:40.118822Z",
  "updatedAt": "2025-07-31T13:36:40.118822Z",
  "cancelAtPeriodEnd": true,
  "scheduledCancellationAt": "2025-12-31",
  "scheduledCancellationReason": "Cliente solicitou cancelamento"
}

Authorizations

X-Client-Id

string

header

required

X-Api-Key

string

header

required

Path Parameters

string<uuid>

required

Id da assinatura que deseja recuperar

Response

Success

string<uuid>

Identificador da assinatura

Example:

"abecf6d6-153e-4fc9-8222-8be5441de581"

name

string

Nome da assinatura

Example:

"Assinatura Premium com Eventos"

clientId

string<uuid>

Identificador do client

Example:

"567265cb-fa7f-419f-9c1c-8e878dd2faf7"

merchantId

string<uuid>

Identificador do merchant

Example:

"90d64a51-d442-426c-bbf9-b66e000e5576"

customerId

string<uuid>

Identificador do cliente

Example:

"b99e159e-27d5-4927-b46e-ae7348f20131"

referenceKey

string

Chave de referência da assinatura

Example:

"SUB-PREMIUM-001"

currency

string

Moeda da assinatura

Example:

"BRL"

items

object[]

Show child attributes

recurrence

object

Show child attributes

paymentMethod

object

Show child attributes

trial

object

Período de trial. Só vem quando a assinatura foi criada com trial

Show child attributes

splitRules

object[]

Regras de divisão de valores entre recebedores. Só vem quando a assinatura tem split

Show child attributes

status

enum<string>

Status da assinatura

Available options:

created,

active,

paused,

canceled,

unpaid,

expired,

trialing

Example:

"created"

amount

integer

Valor de cada ciclo em centavos, a soma de amount vezes quantity dos itens

Example:

29900

liveMode

boolean

Indica se a assinatura está em modo de produção

Example:

true

lastCycle

object | null

Último ciclo da assinatura. Sempre presente nas respostas individuais (GET, CREATE, UPDATE), pode ser null se não houver ciclos. Não traz items.

Show child attributes

createdAt

string<date-time>

Example:

"2025-07-31T13:36:40.118822Z"

updatedAt

string<date-time>

Example:

"2025-07-31T13:36:40.118822Z"

cancelAtPeriodEnd

boolean

Indica se a assinatura tem cancelamento agendado. Enquanto for true, recurrence.cycles mostra o ciclo atual mais um, e o valor anterior volta quando o agendamento é removido

Example:

true

scheduledCancellationAt

string<date>

Data efetiva do cancelamento agendado (YYYY-MM-DD). Só vem quando cancelAtPeriodEnd é true. Sem data enviada, é trial.endDate ou, sem trial, recurrence.nextDueDate

Example:

"2025-12-31"

scheduledCancellationReason

string

Motivo do cancelamento agendado. Só vem quando foi informado

Example:

"Cliente solicitou cancelamento"

Visão Geral

Sub-keys

Cards

Tokens

3DS2 Malga

Charges

Sessions

Purchases

Subscriptions

Customers

Merchants

Providers

Vendors

Sellers

Payouts

Plans

Prepayment

Receipts

Flows

Webhooks

Settings

Recuperar detalhes de assinatura

Authorizations

Path Parameters

Response