For the complete documentation index, see llms.txt. This page is also available as Markdown.

Assinaturas

Nesta seção estão disponibilizados todos os métodos referentes á assinatura do usuário.

Criação de assinatura para um usuário

POST URL_BASE/users/create/user-subscription/{token_do_desenvolvedor}/{token_da_plataforma}

Request Body

Name
Type
Description

product_id*

String

Id do produto

user_id

String

Id do usuário (uuid)

payment_last_date

Date

Data do último pagamento - formato: Y-m-d H:i:s

expiration_date

Date

Data de expiração da assinatura - formato: Y-m-d H:i:s

reference_id

String

Id referência

{
    "check": true,
    "data": {
        "user_subscription": {
            "id": 1234,
            "tenant_id": 4451,
            "active": 1,
            "status": "active",
            "user_id": "550e8400-e29b-41d4-a716-446655440000",
            "package_id": "660e8400-e29b-41d4-a716-446655440001",
            "payment_last_date": "2025-06-18T10:30:00.000000Z",
            "expiration_date": "2026-06-18T00:00:00.000000Z",
            "accession_date": "2025-06-18T10:30:00.000000Z",
            "created_at": "2025-06-18T10:30:00.000000Z",
            "updated_at": "2025-06-18T10:30:00.000000Z"
        }
    },
    "errors": [],
    "messages": ["Subscription criada com sucesso!"]
}

Editar de assinatura para um usuário

PUT URL_BASE/users/update/user-subscription/{token_do_desenvolvedor}/{token_da_plataforma}

Request Body

Name
Type
Description

product_id*

String

Id do produto

user_id*

String

Id do usuário (uuid)

payment_last_date

Date

Data do último pagamento - formato: Y-m-d H:i:s

expiration_date

Date

Data de expiração da assinatura - formato: Y-m-d H:i:s

Ativar a assinatura para um usuário

PUT URL_BASE/users/update/active-user-subscription/{token_do_desenvolvedor}/{token_da_plataforma}

Request Body

Name
Type
Description

product_id*

String

Id do produto

user_id*

String

Id do usuário (uuid)

Desativar a assinatura para um usuário

PUT URL_BASE/users/update/disable-user-subscription/{token_do_desenvolvedor}/{token_da_plataforma}

Request Body

Name
Type
Description

product_id*

String

Id do produto

user_id*

String

Id do usuário (uuid)

Deletar assinatura por id referência

DELETE URL_BASE/users/destroy-subscription-reference-id/{reference_id}/{product_id}/{token_do_desenvolvedor}/{token_da_plataforma}

Após a exclusão do usuário a operação não poderá ser revertida.

Deletar assinatura por id do usuário

DELETE URL_BASE/users/destroy-subscription-user-id/{user_id}/{product_id}/{token_do_desenvolvedor}/{token_da_plataforma}

Após a exclusão do usuário a operação não poderá ser revertida.

Atualizado