---
title: "Criar Assinatura com ou sem plano"
method: POST
path: "/baas/v1/cash/subscriptions"
tags: ["Assinaturas"]
---

# Criar Assinatura com ou sem plano

`POST /baas/v1/cash/subscriptions`

## Query parameters

- `account` integer, required

## Request body

- object
  - `planGalaxPayId` integer — Para criar uma assinatura sem plano, não informe esse campo.
  - `firstPayDayDate` string, date
  - `additionalInfo` string
  - `mainPaymentMethodId` string
  - `Customer` object
    - `myId` string
    - `galaxPayId` integer
    - `name` string
    - `document` string, utc-millisec
    - `emails` string[]
    - `phones` integer[]
    - `invoiceHoldIss` boolean
    - `municipalDocument` string
    - `password` string
    - `Address` object
      - `zipCode` string, utc-millisec
      - `street` string
      - `number` string, utc-millisec
      - `complement` string
      - `neighborhood` string
      - `city` string
      - `state` string
    - `ExtraFields` object[]
      - `tagName` string
      - `tagValue` string
  - `PaymentMethodCreditCard` object
    - `Card` object
      - `myId` string
      - `galaxPayId` integer
      - `cryptData` string
      - `number` string
      - `holder` string
      - `expiresAt` string
      - `cvv` string, color
    - `cardOperatorId` string
    - `useBackupCard` boolean
    - `preAuthorize` boolean
    - `Antifraud` object
      - `ip` string, ip-address — IPv4/IPv6 do cliente.
      - `sessionId` string — SessionId gerado.
      - `Device` object — Informações da máquina que seu cliente usa para efetuar a transação em sua loja.
        - `fingerprint` string — Identificação do navegador(min 3, max 255)
        - `provider` string — Tipo de provedor (min 2, max 255)
        - `model` string — Tipo do modelo utilizado(max 255 chars)
        - `platform` string — Tipo de dispositivo pelo cliente
        - `manufacturer` string — Fabricante(min 2, max 255 chars)
        - `os` string — Qual sistema operacional (min 2, max 255 chars)
        - `browser` string — Navegador (min 2, max 255 chars)
        - `language` string — Linguagem utilizada. Ex: pt-BR.
      - `Payment` object — Informações de pagamento
        - `bin` string, color — Identificação do cartão - primeiros 6 a 10 números.
        - `last4` string, utc-millisec — Os últimos quatro dígitos do cartão de crédito.
        - `amount` number — Valor total do pedido.
        - `expirationDate` string, color — Data de validade do cartão no formato MMAAAA.
        - `description` string — Alguma informação referente ao desconto.
        - `taxId` string, utc-millisec — CPF do portador do cartão
        - `cvvResult` string, utc-millisec — Código de resultado da verificação CVV (verificação do cartão).
        - `avsResult` string, utc-millisec — Código de resultado da verificação do AVS (Serviço de Verificação de Endereço).
        - `sha1` string, utc-millisec — Código de pagamento de integridade (É um HMAC-SHA-256 dos campos da notificação)
        - `name` string — Nome do comprador.
        - `holder` string — Nome do portador do cartão de crédito.
      - `Customer` object — Pessoa que está fazendo a compra
        - `id` string, required — Identificador único do cliente. Pode ser qualquer valor (sequencial, documento, e-mail) desde que seja consistente em pedidos futuros.
        - `dateOfBirth` string, date — Data de nascimento do cliente no formato YYYY-MM-DD
        - `documentType` 'CPF' | 'CNPJ' | 'RG' | 'PASSPORT' | 'OTHER' | 'CPF_CNPJ' — Tipo do documento fiscal do cliente (CPF, CNPJ, RG, PASSPORT, OTHER, CPF_CNPJ).
        - `phone1` string — Número de telefone primário do cliente
        - `phone2` string — Número de telefone secundário do cliente
        - `new` true | false — Flag indicando se o cliente está usando uma conta recém-criada nesta compra.
        - `vip` true | false — Flag indicando se este é um cliente VIP ou comprador frequente.
        - `type` string — Identificador do tipo do cliente.
        - `riskLevel` 'low' | 'medium' | 'high' — Identificador do nível de risco.(low, medium ou high)
        - `riskScore` number — Identificador do score de risco do cliente.
        - `motherName` string — Nome completo da mãe do cliente.
      - `Billing` object — Cobrança
        - `name` string — Nome do titular do cartão
        - `address1` string — Endereço primário da fatura
        - `address2` string — Endereço secundário da fatura
        - `city` string — Cidade do titular
        - `state` string — Estado do titular
        - `zip` string — CEP do titular
        - `country` string — Código do país do titular ISO 3166-2
      - `Cart` object — Lista de produtos no carrinho de compras
        - `sku` string — SKU ou número de inventário do produto ou serviço.
        - `productCode` string — Código de barras ou UPC do produto ou serviço.
        - `name` string — Nome do produto ou serviço
        - `description` string — Descrição de detalhada do produto ou serviço.
        - `unitCost` number — Custo unitário deste produto ou serviço.
        - `quantity` number — Quantidade de unidades compradas.
        - `createdAt` string, date — Data de publicação do produto no site, em formato YYYY-MM-DD
        - `deliveryType` string — Tipo de entrega.
        - `deliverySlaInMinutes` integer — Tempo estimado de entrega em minutos.
        - `sellerId` string — dentificação do vendedor.
    - `3DS` object — Validação 3DS
      - `ExternalEMV` object — Nó de 3DS externo.
        - `embedded` boolean — Informa se o serviço MPI utilizado será da Rede ou terceiro. true: utiliza o serviço MPI da Rede | false: utiliza serviço MPI terceiro O não envio desse campo será considerado o uso do MPI da Rede.
        - `threeDIndicator` string, utc-millisec — Versão do 3DS usado no processo de autenticação pelo MPI.
        - `cavv` string — Código do criptograma utilizado na autenticação da transação e enviado pelo MPI do estabelecimento (pode conter caracteres especiais).
        - `eci` string, utc-millisec — O parâmetro ECI (Eletronic Commerce Indicator) se baseia no valor retornado ao MPI pelas Bandeiras que indica o resultado da autenticação do portador junto ao Emissor.
        - `xid` string — ID da transação de autenticação enviado pelo MPI ao estabelecimento (pode conter caracteres especiais). Deve ser enviado apenas para a utilização do serviço de autenticação 3DS. Campo utilizado somente para bandeira ***Visa.
        - `directoryServerTransactionId` string — ID da transação de autenticação incluída pelo MPI ao estabelecimento (pode conter caracteres especiais). Deve ser enviado apenas para a utilização do serviço de autenticação 3DS.
      - `InternalEMV` object — Informações da validação 3ds interna
        - `userAgent` string — Identificador do browser utilizado pelo comprador no momento da compra.
        - `ip` string, ip-address — Suporta informações somente em iPv4
        - `Device` object — Informações do dispositivo
          - `colorDepth` string, utc-millisec — Campo que representa a estimativa da paleta de cores usada para a exibição de imagens, em bits por pixel. Obtido no navegador do cliente através da propriedade.
          - `deviceType3ds` string — Campo que indica tipo de dispositivo no qual a autenticação ocorre.
          - `javaEnabled` boolean — Campo booleano que representa a capacidade do navegador para executar Java. O valor é aquele retornado pela propriedade navigator.javaEnabled, true ou false.
          - `language` string — Idioma do navegador no formato IETF BCP47, contendo entre 1 e 8 caracteres.
          - `screenHeight` string, color — A altura total da tela do cliente em pixels. O valor é aquele retornado pela propriedade screen.height.
          - `screenWidth` string, color — A largura total da tela do cliente em pixels. O valor é aquele retornado pela propriedade screen.width.
          - `timeZoneOffset` string, utc-millisec — Diferença de horário, em horas, entre o UTC e a hora local do navegador do titular do cartão.
        - `redirectUrl3ds` string, uri — Campo que indica para qual URL o cliente será direcionado após o desafio 3ds.
  - `Split` object
    - `creditcard` object
      - `type` string
      - `Companies` object[]
        - `numberAccount` integer
        - `value` integer
  - `InvoiceConfig` object
    - `description` string
    - `smu` integer
    - `type` string
    - `createOn` string
    - `qtdDaysBeforePayDay` integer
    - `qtdDaysAfterPay` integer
  - `ExtraFields` object[]
    - `tagName` string
    - `tagValue` string

## Response `200`

Success

- object
  - `type` boolean
  - `Subscription` object
    - `myId` string
    - `galaxPayId` integer
    - `planMyId` string
    - `planGalaxPayId` integer
    - `value` integer
    - `quantity` integer
    - `periodicity` string
    - `firstPayDayDate` string, date
    - `mainPaymentMethodId` string
    - `paymentLink` string, uri
    - `status` string
    - `additionalInfo` string
    - `Customer` object
      - `galaxPayId` integer
      - `myId` string
      - `name` string
      - `document` string, utc-millisec
      - `emails` string[]
      - `phones` integer[]
      - `invoiceHoldIss` boolean
      - `municipalDocument` string
      - `createdAt` string, style
      - `updatedAt` string
      - `Address` object
        - `zipCode` string, utc-millisec
        - `street` string
        - `number` string, utc-millisec
        - `complement` string
        - `neighborhood` string
        - `city` string
        - `state` string
      - `ExtraFields` object[]
        - `tagName` string
        - `tagValue` string
    - `Transactions` object[]
      - `myId` string
      - `galaxPayId` integer
      - `value` integer
      - `payday` string, date
      - `payedOutsideGalaxPay` boolean
      - `additionalInfo` string
      - `installment` integer
      - `status` string
      - `datetimeLastSentToOperator` string, style
      - `statusDate` string
      - `Invoice` object
        - `description` string
        - `status` string
        - `statusDescription` string
        - `statusDate` string, style
      - `statusDescription` string
      - `tid` string
      - `authorizationCode` string
      - `reasonDenied` string
      - `Boleto` object
        - `pdf` string, uri
        - `bankLine` string, utc-millisec
        - `bankNumber` integer
        - `barCode` string, utc-millisec
        - `bankEmissor` string
        - `bankAgency` string, utc-millisec
        - `bankAccount` string, utc-millisec
      - `cardOperatorId` string
      - `AbecsReasonDenied` object
        - `code` string, utc-millisec
        - `message` string
      - `Pix` object
        - `qrCode` string
        - `reference` string
        - `image` string, uri
        - `page` string, uri
      - `Antifraud` object
        - `ip` string, ip-address
        - `sessionId` string
        - `sent` boolean
        - `approved` boolean
      - `CreditCard` object
        - `Card` object
          - `myId` string
          - `galaxPayId` integer
          - `number` string
          - `createdAt` string, style
          - `updatedAt` string
          - `Brand` object
            - `id` string
            - `name` string
            - `maxInstallment` integer
            - `operatorIds` string
          - `expiresAt` string
      - `Transaction3DS` object
        - `urlAuthentication` string, uri
    - `PaymentMethodCreditCard` object
      - `cardOperatorId` string
      - `preAuthorize` boolean
      - `Card` object
        - `myId` string
        - `galaxPayId` integer
        - `number` string
        - `createdAt` string, style
        - `updatedAt` string
        - `Brand` object
          - `id` string
          - `name` string
          - `maxInstallment` integer
          - `operatorIds` string
        - `expiresAt` string
        - `isBackup` boolean
    - `PaymentMethodBoleto` object
      - `fine` integer
      - `interest` integer
      - `instructions` string
      - `deadlineDays` integer
      - `Discount` object
        - `qtdDaysBeforePayDay` integer
        - `type` string
        - `value` integer
    - `PaymentMethodPix` object
      - `fine` integer
      - `interest` integer
      - `instructions` string
      - `Deadline` object
        - `type` string
        - `value` integer
      - `Discount` object
        - `qtdDaysBeforePayDay` integer
        - `type` string
        - `value` integer
    - `InvoiceConfig` object
      - `description` string
      - `smu` integer
      - `type` string
      - `createOn` string
    - `ExtraFields` object[]
      - `tagName` string
      - `tagValue` string
    - `Contract` object
      - `name` string
      - `document` string, utc-millisec
      - `ip` string, ip-address
      - `acceptedAt` string, style
      - `pdf` string, uri
  - `Split` object[]
    - `galaxPayId` integer
    - `companyGalaxPayId` integer
    - `billGalaxPayId` integer
    - `type` string
    - `paymentMethod` string
    - `value` integer
    - `groupGalaxPayId` integer

## Other responses

- `500` — Internal Server Error

---

[API](https://skmtc.net/celcoin/apis/api-para-transa-es.md) · [All operations](https://skmtc.net/celcoin/apis/api-para-transa-es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/celcoin/api-para-transa-es/revisions/85dd6188a37b/schema)