Pagar.me

https://docs.pagar.me/
Admin
Pagar.me provides a comprehensive payment API for businesses to integrate various payment...
Tokens:1,603
Snippets:11
Trust Score:9.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Pagar.me Recurrence Subscription Management API

Source: https://docs.pagar.me/reference

API endpoints for managing customer subscriptions, including creation, listing, cancellation, and various updates to card, metadata, payment method, start date, and minimum price.

```APIDOC
POST /reference/criar-assinatura-avulsa
  - Creates a standalone subscription.
POST /reference/criar-assinatura-de-plano-1
  - Creates a subscription based on an existing plan.
GET /reference/obter-assinatura-1
  - Retrieves a specific subscription by ID.
GET /reference/listar-assinaturas-1
  - Lists all available subscriptions.
DELETE /reference/cancelar-assinatura-1
  - Cancels an existing subscription.
PATCH /reference/editar-cart%C3%A3o-da-assinatura-1
  - Edits the card associated with a subscription.
PATCH /reference/editar-metadados-da-assinatura-1
  - Edits the metadata of a subscription.
PATCH /reference/editar-meio-de-pagamento-da-assinatura
  - Edits the payment method of a subscription.
PATCH /reference/editar-data-de-in%C3%ADcio-da-assinatura-1
  - Edits the start date of a subscription.
PATCH /reference/editar-minimum-price-da-assinatura
  - Edits the minimum price of a subscription.
POST /reference/ativar-faturamento-manual-1
  - Activates manual billing for a subscription.
DELETE /reference/desativar-faturamento-manual-1
  - Deactivates manual billing for a subscription.
```

--------------------------------

### Pagar.me Payment Link API Endpoints

Source: https://docs.pagar.me/reference

API endpoints for managing payment links, including creation, retrieval, activation, and cancellation.

```APIDOC
POST /reference/create-link
  - Creates a new payment link.
GET /reference/obter-link
  - Retrieves a specific payment link by ID.
GET /reference/obter-links
  - Lists all available payment links.
PATCH /reference/ativar-link-de-pagamento-em-constru%C3%A7%C3%A3o
  - Activates a payment link that is under construction.
PATCH /reference/cancelar-um-link-de-pagamento
  - Cancels an existing payment link.
```

--------------------------------

### Pagar.me Recurrence Discount Management API

Source: https://docs.pagar.me/reference

API endpoints for managing discounts applied to recurrence, including adding, retrieving, listing, and removing discounts.

```APIDOC
POST /reference/incluir-desconto-1
  - Adds a discount to a recurrence.
GET /reference/obter-desconto-1
  - Retrieves a specific discount by ID.
GET /reference/listar-descontos-2
  - Lists all available discounts.
DELETE /reference/remover-desconto-1
  - Removes a discount from a recurrence.
```

--------------------------------

### Pagar.me Recurrence Plan Management API

Source: https://docs.pagar.me/reference

API endpoints for managing recurrence plans, including creation, retrieval, modification, and listing.

```APIDOC
POST /reference/criar-plano-1
  - Creates a new recurrence plan.
GET /reference/obter-plano-1
  - Retrieves a specific recurrence plan by ID.
PATCH /reference/editar-metadados-do-plano-1
  - Edits the metadata of a recurrence plan.
PUT /reference/editar-plano-1
  - Edits the details of a recurrence plan.
DELETE /reference/excluir-plano-1
  - Deletes a recurrence plan.
GET /reference/listar-planos-1
  - Lists all available recurrence plans.
```

--------------------------------

### Pagar.me Recurrence Cycle Management API

Source: https://docs.pagar.me/reference

API endpoints for managing recurrence cycles, including renewal, retrieval, and listing.

```APIDOC
POST /reference/renovar-ciclo-1
  - Renews a recurrence cycle.
GET /reference/obter-ciclo-1
  - Retrieves a specific recurrence cycle by ID.
GET /reference/listar-ciclos-1
  - Lists all available recurrence cycles.
```

--------------------------------

### Pagar.me Recurrence Subscription Item Usage API

Source: https://docs.pagar.me/reference

API endpoints for managing usage records for subscription items, including adding, removing, and listing usage.

```APIDOC
POST /reference/incluir-uso
  - Adds a usage record for a subscription item.
DELETE /reference/remover-uso
  - Removes a usage record for a subscription item.
GET /reference/listar-uso
  - Lists all usage records for a subscription item.
```

--------------------------------

### Pagar.me Recurrence Subscription Item Management API

Source: https://docs.pagar.me/reference

API endpoints for managing individual items within a subscription, including adding, listing, editing, and removing items.

```APIDOC
POST /reference/incluir-item-1
  - Adds an item to a subscription.
GET /reference/listar-%C3%ADtens-de-uma-assinatura
  - Lists all items associated with a subscription.
PUT /reference/editar-item
  - Edits an existing item within a subscription.
DELETE /reference/remover-item
  - Removes an item from a subscription.
```

--------------------------------

### Pagar.me Recurrence Plan Item Management API

Source: https://docs.pagar.me/reference

API endpoints for managing items associated with a recurrence plan, including adding, editing, and removing items.

```APIDOC
POST /reference/incluir-item-2
  - Adds an item to a recurrence plan.
PUT /reference/editar-item-1
  - Edits an existing item within a recurrence plan.
DELETE /reference/remover-item-1
  - Removes an item from a recurrence plan.
```

--------------------------------

### Pagar.me Recurrence Increment Management API

Source: https://docs.pagar.me/reference

API endpoints for managing increments applied to recurrence, including adding, retrieving, listing, and removing increments.

```APIDOC
POST /reference/incluir-incremento-1
  - Adds an increment to a recurrence.
GET /reference/obter-incremento-1
  - Retrieves a specific increment by ID.
GET /reference/listar-incrementos
  - Lists all available increments.
DELETE /reference/remover-incremento-1
  - Removes an increment from a recurrence.
```

--------------------------------

### Pagar.me Recurrence Invoice Management API

Source: https://docs.pagar.me/reference

API endpoints for managing invoices related to recurrence, including creation, retrieval, listing, metadata editing, and cancellation.

```APIDOC
POST /reference/criar-fatura-1
  - Creates a new invoice.
GET /reference/obter-fatura-1
  - Retrieves a specific invoice by ID.
GET /reference/listar-faturas-1
  - Lists all available invoices.
PATCH /reference/editar-metadados-da-fatura-1
  - Edits the metadata of an invoice.
DELETE /reference/cancelar-fatura-1
  - Cancels an existing invoice.
```

--------------------------------

### Pagar.me Recurrence Split Rules API

Source: https://docs.pagar.me/reference

API endpoint for editing split rules within recurrence.

```APIDOC
PATCH /reference/editar-ativa%C3%A7%C3%A3o-ou-regras-do-split
  - Edits the activation or rules for split payments in recurrence.
```
Tokens:
Raw