---
title: "Incluir item"
url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/incluir-item-1"
---
> Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md
# Incluir item
`POST` `/subscriptions/{subscription_id}/items`
Operation ID: `incluir-item-1`
Através do identificador da assinatura (`subscription_id`) é possível incluir itens na assinatura do cliente.
## Path parameters
- `subscription_id` (string, required) - Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.
## Request body
Content types: `application/json`
## Responses
- `200` - 200
- `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}/items:
post:
summary: Incluir item
description: Através do identificador da assinatura (`subscription_id`) é
possível incluir itens na assinatura do cliente.
operationId: incluir-item-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:
- description
- pricing_scheme
- quantity
properties:
plan_item_id:
type: string
description: "Código do item do plano.
Max: 36 caracteres."
description:
type: string
description: "Descrição do item.
Max: 256 caracteres.
**Obrigatório** caso
o `plan_item_id` não seja informado."
cycles:
type: integer
description: Indica quantas vezes o item será cobrado.
Caso não seja
informado, o item será cobrado até que seja excluído o
desativado.
format: int32
pricing_scheme:
type: object
description: Esquema de precificação.
[Saiba mais sobre
precificação](https://docs.pagar.me/reference/precifica%C3%A7%C3%A3o).
required:
- scheme_type
properties:
scheme_type:
type: string
description: "Esquema de precificação do item. Valores possíveis: **unit**,
**package**, **volume** e **tier**. Valor default: unit"
default: Unit
price:
type: integer
description: "Valor do item. Este atributo está disponível para o scheme_type :
**Unit**"
format: int32
mininum_price:
type: integer
description: Valor mínimo a ser cobrado.
format: int32
price_brackets:
type: array
description: "Intervalo de preços. Este atributo está disponível para os
scheme_type : **package**, **volume** e **tier**."
items:
properties:
start_quantity:
type: integer
description: Valor que define a quantidade inicial de unidades do intervalo.
format: int32
end_quantity:
type: integer
description: Valor que define a quantidade final de unidades do intervalo.
format: int32
overage_price:
type: integer
description: Valor para cálculo do preço por unidade que exceder o intervalo.
format: int32
price:
type: integer
description: "Valor para cálculo do preço dentro do intervalo. OBS: o preço a
ser cobrado do cliente será calculado de acordo
com a quantidade e o scheme_type"
format: int32
type: object
discounts:
type: array
description: Descontos do item.
[Saiba mais sobre
desconto](https://docs.pagar.me/reference/desconto-1)
items:
properties:
cycles:
type: string
description: Número de vezes que o desconto será aplicado.
value:
type: string
description: Valor do desconto.
discount_type:
type: string
description: "Tipo do desconto. Valores possíveis: flat ou percentage. Valor
padrão: percentage."
type: object
quantity:
type: integer
description: Quantidade de itens.
**Obrigatório** caso
**pricing_scheme.scheme_type** seja **unit**
format: int32
name:
type: string
description: Nome do item da assinatura.
increments:
type: array
description: Incrementos do item.
[Saiba mais sobre
desconto](https://docs.pagar.me/reference/incremento-1)
items:
properties:
value:
type: integer
description: Valor do incremento.
format: int32
cycles:
type: string
description: Número de vezes que o incremento será aplicado.
increment_type:
type: string
description: "Tipo do incremento. Valores possíveis: flat ou percentage. Valor
padrão: percentage."
type: object
examples:
Request Example:
value:
description: Celular
cycles: 1
quantity: 1
pricing_scheme:
price: 99
responses:
"200":
description: "200"
content:
application/json:
examples:
Result:
value: |-
{
"id": "si_WQEmvEEfGigkL0Zx",
"description": "Celular",
"cycles": 1,
"quantity": 1,
"status": "active",
"created_at": "2017-07-28T21:00:26Z",
"updated_at": "2017-07-28T21:00:26Z",
"pricing_scheme": {
"price": 99,
"scheme_type": "unit"
},
"subscription": {
"id": "sub_z4ogwpZfdKCnGj9m",
"code": "3670A7IQWL",
"start_at": "2017-07-28T00:00:00Z",
"interval": "month",
"interval_count": 3,
"billing_type": "prepaid",
"next_billing_at": "2017-10-28T00:00:00Z",
"payment_method": "credit_card",
"currency": "BRL",
"installments": 3,
"status": "active",
"created_at": "2017-07-28T20:59:18Z",
"updated_at": "2017-07-28T20:59:18Z",
"metadata": {
"id": "my_subscription_id"
}
}
}
schema:
type: object
properties:
id:
type: string
example: si_WQEmvEEfGigkL0Zx
description:
type: string
example: Celular
cycles:
type: integer
example: 1
default: 0
quantity:
type: integer
example: 1
default: 0
status:
type: string
example: active
created_at:
type: string
example: 2017-07-28T21:00:26Z
updated_at:
type: string
example: 2017-07-28T21:00:26Z
pricing_scheme:
type: object
properties:
price:
type: integer
example: 99
default: 0
scheme_type:
type: string
example: unit
subscription:
type: object
properties:
id:
type: string
example: sub_z4ogwpZfdKCnGj9m
code:
type: string
example: 3670A7IQWL
start_at:
type: string
example: 2017-07-28T00:00:00Z
interval:
type: string
example: month
interval_count:
type: integer
example: 3
default: 0
billing_type:
type: string
example: prepaid
next_billing_at:
type: string
example: 2017-10-28T00:00:00Z
payment_method:
type: string
example: credit_card
currency:
type: string
example: BRL
installments:
type: integer
example: 3
default: 0
status:
type: string
example: active
created_at:
type: string
example: 2017-07-28T20:59:18Z
updated_at:
type: string
example: 2017-07-28T20:59:18Z
metadata:
type: object
properties:
id:
type: string
example: my_subscription_id
"422":
description: "422"
content:
application/json:
examples:
Result:
value: |-
{
"message": "The request is invalid.",
"errors": {
"item.cycles": [
"The field cycles must be greater than or equal to 1"
]
},
"request": {
"description": "Celular",
"cycles": 0,
"quantity": 1,
"pricing_scheme": {
"price": 99,
"scheme_type": "unit"
}
}
}
schema:
type: object
properties:
message:
type: string
example: The request is invalid.
errors:
type: object
properties:
item.cycles:
type: array
items:
type: string
example: The field cycles must be greater than or equal to 1
request:
type: object
properties:
description:
type: string
example: Celular
cycles:
type: integer
example: 0
default: 0
quantity:
type: integer
example: 1
default: 0
pricing_scheme:
type: object
properties:
price:
type: integer
example: 99
default: 0
scheme_type:
type: string
example: unit
deprecated: false
security:
- sec0: []
components:
securitySchemes:
sec0:
type: http
scheme: basic
```