---
title: "Incluir incremento"
url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/incluir-incremento-1"
---
> Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md
# Incluir incremento
`POST` `/subscriptions/{subscription_id}/increments`
Operation ID: `incluir-incremento-1`
Este recurso permite adicionar um incremento, através do identificador da assinatura (`subscription_id`).
## Path parameters
- `subscription_id` (string, required) - Código da assinatura.
Formato `sub_XXXXXXXXXXXXXXXX`
## Request body
Content types: `application/json`
## Responses
- `200` - 200
- `404` - 404
- `422` - 422
## OpenAPI definition
```yaml
openapi: 3.1.0
info:
title: Pagar.me v5 API (Legado)
version: 5.0.0
servers:
- url: https://api.stone.com.br/core/v5
paths:
/subscriptions/{subscription_id}/increments:
post:
summary: Incluir incremento
description: Este recurso permite adicionar um incremento, através do
identificador da assinatura (`subscription_id`).
operationId: incluir-incremento-1
parameters:
- name: subscription_id
in: path
description: Código da assinatura.
Formato `sub_XXXXXXXXXXXXXXXX`
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
type: object
required:
- value
- increment_type
properties:
value:
type: string
description: Valor do incremento.
increment_type:
type: string
description: "Tipo do incremento.
Valores possíveis: **flat** ou
**percentage**. O padrão é **percentage**"
cycles:
type: integer
description: Indica quantas vezes o incremento será aplicado.
Caso não seja
informada, o incremento será aplicado até que o item seja
excluído
format: int32
item_id:
type: string
description: "Código do item da assinatura.
Formato: `si_XXXXXXXXXXXXXXXX`
Caso seja informado, o incremento será aplicado no item.
Max: 36 caracteres"
examples:
Request Example:
value:
value: 20
increment_type: percentage
responses:
"200":
description: "200"
content:
application/json:
examples:
Result:
value: |-
{
"id": "inc_IYzpxgjsOs0fDIoP",
"value": 20,
"increment_type": "percentage",
"status": "active",
"created_at": "2017-04-04T18:36:43Z",
"subscription": {
"id": "sub_o0Jw4WYCMuPNqzGr",
"code": "09NFPLBZY0",
"start_at": "2017-04-04T00:00:00Z",
"interval": "month",
"interval_count": 1,
"billing_type": "postpaid",
"next_billing_at": "2017-05-04T00:00:00Z",
"payment_method": "credit_card",
"currency": "BRL",
"statement_descriptor": "Spotify",
"installments": 1,
"status": "active",
"created_at": "2017-04-04T18:21:17Z",
"updated_at": "2017-04-04T18:21:17Z"
}
}
schema:
type: object
properties:
id:
type: string
example: inc_IYzpxgjsOs0fDIoP
value:
type: integer
example: 20
default: 0
increment_type:
type: string
example: percentage
status:
type: string
example: active
created_at:
type: string
example: 2017-04-04T18:36:43Z
subscription:
type: object
properties:
id:
type: string
example: sub_o0Jw4WYCMuPNqzGr
code:
type: string
example: 09NFPLBZY0
start_at:
type: string
example: 2017-04-04T00:00:00Z
interval:
type: string
example: month
interval_count:
type: integer
example: 1
default: 0
billing_type:
type: string
example: postpaid
next_billing_at:
type: string
example: 2017-05-04T00:00:00Z
payment_method:
type: string
example: credit_card
currency:
type: string
example: BRL
statement_descriptor:
type: string
example: Spotify
installments:
type: integer
example: 1
default: 0
status:
type: string
example: active
created_at:
type: string
example: 2017-04-04T18:21:17Z
updated_at:
type: string
example: 2017-04-04T18:21:17Z
"404":
description: "404"
content:
application/json:
examples:
Result:
value: |-
{
"message": "Subscription not found."
}
schema:
type: object
properties:
message:
type: string
example: Subscription not found.
"422":
description: "422"
content:
application/json:
examples:
Result:
value: >-
{
"message": "The request is invalid.",
"errors": {
"increment.increment_type": [
"The increment_type field is invalid. Possible values are 'flat' or 'percentage'."
]
},
"request": {
"increment_type": "null",
"value": 10
}
}
schema:
oneOf:
- type: object
properties:
message:
type: string
example: The request is invalid.
errors:
type: object
properties:
increment.value:
type: array
items:
type: string
example: The value field should be greater than the zero.
request:
type: object
properties:
increment_type:
type: string
example: percentage
- type: object
properties:
message:
type: string
example: The request is invalid.
errors:
type: object
properties:
increment.increment_type:
type: array
items:
type: string
example: The increment_type field is invalid. Possible values are 'flat' or
'percentage'.
request:
type: object
properties:
increment_type:
type: string
example: "null"
value:
type: integer
example: 10
default: 0
deprecated: false
security:
- sec0: []
components:
securitySchemes:
sec0:
type: http
scheme: basic
```