--- updatedAt: 2026-04-06T17:32:34.000Z agentTools: projectIndex: https://docs.pagar.me/v4/llms.txt --- # Split com assinatura Além de cobrar o seu cliente de forma recorrente, você também pode dividir as transações resultantes dessas assinaturas, entre dois ou mais recebedores de sua company. Os parâmetros a serem passados, além dos já existentes e explicados na seção anterior, são o conjunto `split_rules`: > ❗️ Atenção: Essa versão de API será descontinuada > > Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5. > > No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação. > > Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5. > > Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard. ## Dados necessários para uma assinatura > 📘 Dados obrigatórios > > O e-mail do cliente é uma informação obrigatória, uma vez que utilizamos ele para enviar e-mails de assinatura. > 🚧 Antifraude > > A primeira transação criada em uma assinatura passa por antifraude, logo, é obrigatório enviar todos os dados de customer. ## Valores de uma assinatura > ❗️ Dando descontos na assinatura > > Só é possível dar descontos em uma assinatura através de troca para um plano mais barato, mas vale ressaltar que isso gera uma nova periodicidade. Mais em: [Fluxo de cobrança](https://docs.pagar.me/docs/fluxo-de-cobranca). ## Observações > 📘 ID do plano > > Lembre-se de passar o ID de seu plano em todas as requests, para que não seja necessário recriar todas assinaturas que ficaram com plan\_id = null. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "api-settings", "version": "4" }, "servers": [ { "url": "https://api.pagar.me/1" } ], "components": { "securitySchemes": { "sec0": { "x-default": "", "type": "apiKey", "name": "api_key", "in": "query" } } }, "security": [ { "sec0": [] } ], "paths": { "/subscriptions/": { "post": { "summary": "Split com assinatura", "description": "Além de cobrar o seu cliente de forma recorrente, você também pode dividir as transações resultantes dessas assinaturas, entre dois ou mais recebedores de sua company. Os parâmetros a serem passados, além dos já existentes e explicados na seção anterior, são o conjunto `split_rules`:", "operationId": "criando-assinaturas-com-split", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "plan_id", "card_hash", "card_number", "card_cvv", "card_holder_name", "card_expiration_date", "card_id", "split_rules" ], "properties": { "plan_id": { "type": "string", "description": "ID do plano a ser associado a uma assinatura" }, "payment_method": { "type": "string", "description": "Método de pagamento da assinatura. Aceita dois tipos: credit_card e boleto" }, "card_hash": { "type": "string", "description": "Dados encriptados do cartão do cliente. Você também pode usar o card_id ao invés do card_hash" }, "card_number": { "type": "string", "description": "Número do cartão, se for uma assinatura de cartão" }, "card_cvv": { "type": "string", "description": "CVV do cartão, se for uma assinatura paga com cartão" }, "card_holder_name": { "type": "string", "description": "Nome do detentor do cartão se for uma assinatura paga com cartão" }, "card_expiration_date": { "type": "string", "description": "Data de expiração do cartão, se for uma assinatura paga com cartão" }, "card_id": { "type": "string", "description": "ID do cartão a ser cobrado, se for uma assinatura paga com cartão" }, "postback_url": { "type": "string", "description": "URL para a qual a nossa API irá enviar requisições informando alterações de status da assinatura em questão" }, "split_rules": { "type": "array", "description": "Regras de split para transações criadas a partir de sua assinatura", "items": { "properties": { "recipient_id": { "type": "string", "description": "Id do recebedor" }, "liable": { "type": "boolean", "description": "Se o recebedor é responsável ou não pelo chargeback. Default `true` para todos os recebedores da transação." }, "charge_processing_fee": { "type": "boolean", "description": "Se o recebedor será cobrado das taxas da criação da transação. Default `true` para todos os recebedores da transação." }, "percentage": { "type": "integer", "description": "Qual a porcentagem que o recebedor receberá. Deve estar entre 0 e 100. Se amount já está preenchido, não é obrigatório", "format": "int32" }, "amount": { "type": "integer", "description": "Qual o valor da transação o recebedor receberá. Se percentage já está preenchido, não é obrigatório", "format": "int32" }, "charge_remainder": { "type": "boolean", "description": "Se o recebedor deverá pagar os eventuais restos das taxas, calculadas em porcentagem. Sendo que o default vai para o primeiro recebedor definido na regra." } }, "required": [ "recipient_id" ], "type": "object" } }, "customer": { "properties": { "email": { "type": "string", "description": "E-mail do cliente" }, "name": { "type": "string", "description": "Nome completo ou razão social do cliente que está realizando a transação" }, "document_number": { "type": "string", "description": "CPF ou CNPJ do cliente, sem separadores" }, "address": { "properties": { "street": { "type": "string", "description": "logradouro (rua, avenida, etc) do cliente" }, "street_number": { "type": "string", "description": "Número da residência/estabelecimento do cliente" }, "complementary": { "type": "string", "description": "complemento do endereço do cliente" }, "neighborhood": { "type": "string", "description": "bairro de localização do cliente" }, "zipcode": { "type": "string", "description": "CEP do imóvel do cliente, sem separadores" } }, "required": [ "street", "street_number", "neighborhood", "zipcode" ], "type": "object" }, "phone": { "properties": { "ddd": { "type": "string", "description": "DDD do telefone do cliente" }, "number": { "type": "string", "description": "número de telefone do cliente" } }, "required": [ "ddd", "number" ], "type": "object" }, "gender": { "type": "string", "description": "Gênero do cliente" }, "born_at": { "type": "string", "description": "Data de nascimento do cliente. Ex: 11-02-1985", "format": "date" } }, "required": [ "email", "name", "document_number" ], "type": "object" }, "metadata": { "type": "string", "description": "Você pode passar dados adicionais na criação da transação para facilitar uma futura análise de dados tanto em nossa dashboard, quanto por seus sistemas. Ex: metadata[ idProduto ]=13933139", "format": "json" }, "reference_key": { "type": "string", "description": "Valor único que identifica a transação para permitir uma nova tentativa de requisição com a segurança de que a mesma operação não será executada duas vezes acidentalmente. **OBS**: Não pode ser igual a um valor já usado em uma criação de transação" }, "boleto_fine": { "properties": { "days": { "type": "string", "description": "Dias após a expiração do boleto quando a multa deve ser cobrada" }, "amount": { "type": "string", "description": "Valor em centavos da multa por atraso no pagamento do boleto" } }, "required": [], "type": "object" }, "boleto_interest": { "properties": { "days": { "type": "string", "description": "Dias após a expiração do boleto quando o juros deve ser cobrado" }, "amount": { "type": "string", "description": "Valor em porcentagem da taxa de juros que será cobrado por dia de atraso do boleto" } }, "required": [], "type": "object" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"object\": \"subscription\",\n \"plan\": {\n \"object\": \"plan\",\n \"id\": 12783,\n \"amount\": 31000,\n \"days\": 30,\n \"name\": \"Plano Ouro\",\n \"trial_days\": 0,\n \"date_created\": \"2015-03-03T16:56:32.000Z\",\n \"payment_methods\": [\"boleto\", \"credit_card\"],\n \"color\": null,\n \"charges\": null,\n \"installments\": 1\n },\n \"id\": 16892,\n \"current_transaction\": {\n \"object\": \"transaction\",\n \"status\": \"waiting_payment\",\n \"refuse_reason\": null,\n \"status_reason\": \"acquirer\",\n \"acquirer_response_code\": null,\n \"acquirer_name\": \"development\",\n \"authorization_code\": null,\n \"soft_descriptor\": null,\n \"tid\": null,\n \"nsu\": null,\n \"date_created\": \"2015-04-14T20:17:18.000Z\",\n \"date_updated\": \"2015-04-14T20:17:19.000Z\",\n \"amount\": 31000,\n \"installments\": 1,\n \"id\": 194402,\n \"cost\": 0,\n \"card_holder_name\": null,\n \"card_last_digits\": null,\n \"card_first_digits\": null,\n \"card_brand\": null,\n \"postback_url\": null,\n \"payment_method\": \"boleto\",\n \"antifraud_score\": null,\n \"boleto_url\": \"https://pagar.me\",\n \"boleto_barcode\": \"1234 5678\",\n \"boleto_expiration_date\": \"2015-04-21T20:17:18.000Z\",\n \"referer\": \"api_key\",\n \"ip\": \"179.185.132.108\",\n \"subscription_id\": 16892,\n \"metadata\": {}\n },\n \"postback_url\": \"http://requestb.in/zyn5obzy\",\n \"payment_method\": \"boleto\",\n \"current_period_start\": null,\n \"current_period_end\": null,\n \"charges\": 0,\n \"status\": \"unpaid\",\n \"date_created\": \"2015-04-14T20:17:19.000Z\",\n \"phone\": null,\n \"address\": null,\n \"customer\": {\n \"object\": \"customer\",\n \"document_number\": null,\n \"document_type\": \"cpf\",\n \"name\": null,\n \"email\": \"api@test.com\",\n \"born_at\": null,\n \"gender\": null,\n \"date_created\": \"2015-03-04T18:40:03.000Z\",\n \"id\": 14437\n },\n \"card\": null,\n \"metadata\": null\n}" } }, "schema": { "type": "object", "properties": { "object": { "type": "string", "example": "subscription" }, "plan": { "type": "object", "properties": { "object": { "type": "string", "example": "plan" }, "id": { "type": "integer", "example": 12783, "default": 0 }, "amount": { "type": "integer", "example": 31000, "default": 0 }, "days": { "type": "integer", "example": 30, "default": 0 }, "name": { "type": "string", "example": "Plano Ouro" }, "trial_days": { "type": "integer", "example": 0, "default": 0 }, "date_created": { "type": "string", "example": "2015-03-03T16:56:32.000Z" }, "payment_methods": { "type": "array", "items": { "type": "string", "example": "boleto" } }, "color": {}, "charges": {}, "installments": { "type": "integer", "example": 1, "default": 0 } } }, "id": { "type": "integer", "example": 16892, "default": 0 }, "current_transaction": { "type": "object", "properties": { "object": { "type": "string", "example": "transaction" }, "status": { "type": "string", "example": "waiting_payment" }, "refuse_reason": {}, "status_reason": { "type": "string", "example": "acquirer" }, "acquirer_response_code": {}, "acquirer_name": { "type": "string", "example": "development" }, "authorization_code": {}, "soft_descriptor": {}, "tid": {}, "nsu": {}, "date_created": { "type": "string", "example": "2015-04-14T20:17:18.000Z" }, "date_updated": { "type": "string", "example": "2015-04-14T20:17:19.000Z" }, "amount": { "type": "integer", "example": 31000, "default": 0 }, "installments": { "type": "integer", "example": 1, "default": 0 }, "id": { "type": "integer", "example": 194402, "default": 0 }, "cost": { "type": "integer", "example": 0, "default": 0 }, "card_holder_name": {}, "card_last_digits": {}, "card_first_digits": {}, "card_brand": {}, "postback_url": {}, "payment_method": { "type": "string", "example": "boleto" }, "antifraud_score": {}, "boleto_url": { "type": "string", "example": "https://pagar.me" }, "boleto_barcode": { "type": "string", "example": "1234 5678" }, "boleto_expiration_date": { "type": "string", "example": "2015-04-21T20:17:18.000Z" }, "referer": { "type": "string", "example": "api_key" }, "ip": { "type": "string", "example": "179.185.132.108" }, "subscription_id": { "type": "integer", "example": 16892, "default": 0 }, "metadata": { "type": "object", "properties": {} } } }, "postback_url": { "type": "string", "example": "http://requestb.in/zyn5obzy" }, "payment_method": { "type": "string", "example": "boleto" }, "current_period_start": {}, "current_period_end": {}, "charges": { "type": "integer", "example": 0, "default": 0 }, "status": { "type": "string", "example": "unpaid" }, "date_created": { "type": "string", "example": "2015-04-14T20:17:19.000Z" }, "phone": {}, "address": {}, "customer": { "type": "object", "properties": { "object": { "type": "string", "example": "customer" }, "document_number": {}, "document_type": { "type": "string", "example": "cpf" }, "name": {}, "email": { "type": "string", "example": "api@test.com" }, "born_at": {}, "gender": {}, "date_created": { "type": "string", "example": "2015-03-04T18:40:03.000Z" }, "id": { "type": "integer", "example": 14437, "default": 0 } } }, "card": {}, "metadata": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl -X POST https://api.pagar.me/1/subscriptions -H \"Content-Type: application/json\" -d '{\n \"api_key\":\"SUA API KEY\",\n \"card_number\": \"4242424242424242\",\n \"card_cvv\": \"122\",\n \"card_holder_name\": \"Aardvark Silva\",\n \"card_expiration_date\": \"1220\",\n \"payment_method\": \"credit_card\",\n \"customer\":{\n \"email\":\"aardvark.silva@pagar.me\",\n \"name\":\"nome\",\n \"document_number\":\"35965816804\",\n \"address\":{\n \"zipcode\":\"06350270\",\n \"neighborhood\":\"bairro\",\n \"street\":\"rua\",\n \"street_number\":\"122\"\n },\n \"phone\": {\n \"number\":\"87654321\",\n \"ddd\":\"11\"\n }\n } ,\n \"plan_id\":\"89226\",\n \"amount\": 10000,\n \"split_rules\": [\n {\n \"recipient_id\": \"re_cj2wd5ul500d4946do7qtjrvk\",\n \"percentage\": 20,\n \"liable\": true,\n \"charge_processing_fee\": true\n },{\n \"recipient_id\": \"re_cj2wd5u2600fecw6eytgcbkd0\",\n \"percentage\": 80,\n \"liable\": true,\n \"charge_processing_fee\": true\n }\n ]\n}'" }, { "language": "ruby", "code": "require 'pagarme'\n\nPagarMe.api_key = \"ak_test_grXijQ4GicOa2BLGZrDRTR5qNQxJW0\"\n\nplan = PagarMe::Plan.find_by_id(\"12783\")\n\nsubscription = PagarMe::Subscription.new({\n :payment_method => 'credit_card',\n :card_number => \"4901720080344448\",\n :card_holder_name => \"Jose da Silva\",\n :card_expiration_month => \"10\",\n :card_expiration_year => \"15\",\n :card_cvv => \"314\",\n :postback_url => \"http://test.com/postback\",\n :customer => {\n :name => \"John Appleseed\",\n :document_number => \"92545278157\",\n :email => \"jappleseed@apple.com\",\n :address => {\n :street => \"Rua Dr. Geraldo Campos Moreira\",\n :neighborhood => \"Cidade Monções\",\n :zipcode => \"04571020\",\n :street_number => \"240\"\n },\n :phone => {\n :ddd => \"11\"\n :number => \"15510101\"\n }\n },\n :split_rules: [\n {\n recipient_id: \"re_cj2wd5ul500d4946do7qtjrvk\",\n percentage: 10,\n liable: true,\n charge_processing_fee: true\n } ,\n {\n recipient_id: \"re_cj2wd5u2600fecw6eytgcbkd0\",\n percentage: 90,\n liable: true,\n charge_processing_fee: true\n } \n ])\nsubscription.plan = plan\n\nsubscription.create" }, { "language": "php", "code": "subscriptions()->create([\n 'plan_id' => 123456,\n 'card_id' => 'card_abc123456',\n 'payment_method' => 'credit_card',\n 'postback_url' => 'http://www.pudim.com.br',\n 'customer' => [\n 'email' => 'time@unix.com',\n 'name' => 'Unix Time',\n 'document_number' => '75948706036',\n 'address' => [\n 'street' => 'Rua de Teste',\n 'street_number' => '100',\n 'complementary' => 'Apto 666',\n 'neighborhood' => 'Bairro de Teste',\n 'zipcode' => '88370801'\n ],\n 'phone' => [\n 'ddd' => '01',\n 'number' => '923456780'\n ],\n 'gender' => 'other',\n 'born_at' => '1970-01-01',\n ],\n 'amount' => 10000,\n 'split_rules' => [\n [\n 'recipient_id' => 're_abc1234abc1234abc1234abc1',\n 'percentage' => 20,\n 'liable' => true,\n 'charge_processing_fee' => true,\n ],\n [\n 'recipient_id' => 're_abc1234abc1234abc1234abc1',\n 'percentage' => 80,\n 'liable' => true,\n 'charge_processing_fee' => true,\n ]\n ],\n 'metadata' => [\n 'foo' => 'bar'\n ]\n]);" }, { "language": "csharp", "code": "Subscription subscription = new Subscription\n{\n PaymentMethod = PaymentMethod.CreditCard,\n CardNumber = \"4901720080344448\",\n CardHolderName = \"Jose da Silva\",\n CardExpirationDate = \"1021\",\n CardCvv = \"123\"\n};\nsubscription.Plan = PagarMeService.GetDefaultService().Plans.Find(ID_PLANO);\nCustomer customer = new Customer\n{\n Name = \"John Appleseed\",\n DocumentNumber = \"92545278157\",\n Email = \"jappleseed@apple.com\",\n Address = new Address\n {\n Street = \"Rua Dr. Geraldo Campos Moreira\",\n Neighborhood = \"Cidade Monções\",\n Zipcode = \"04571020\",\n StreetNumber = \"240\"\n },\n Phone = new Phone\n {\n Ddd = \"11\",\n Number = \"988774455\"\n }\n};\n\nvar split = new SplitRule[]\n{\n\n new SplitRule\n {\n RecipientId = \"ID_RECEBEDOR\",\n ChargeProcessingFee = true,\n Liable = true,\n Percentage = 20\n },\n new SplitRule\n {\n RecipientId = \"ID_RECEBEDOR\",\n ChargeProcessingFee = true,\n Liable = true,\n Percentage = 80\n }\n\n};\n\nsubscription.SplitRules = split;\n\nsubscription.Customer = customer;\n\nsubscription.Save();" }, { "language": "java", "code": "import java.util.Collection;\nimport me.pagar.model.Customer;\nimport me.pagar.model.Address;\nimport me.pagar.model.Card;\nimport me.pagar.model.Phone;\nimport me.pagar.model.Subscription;\nimport me.pagar.model.SplitRule;\n\nPhone phone = new Phone();\nphone.setDdd(\"11\");\nphone.setDdi(\"55\");\nphone.setNumber(\"99999999\");\n\nString street = \"Avenida Brigadeiro Faria Lima\";\nString streetNumber = \"1811\";\nString neighborhood = \"Jardim Paulistano\";\nString zipcode = \"01451001\";\nAddress address = new Address(street, streetNumber, neighborhood, zipcode);\n\nString name = \"Aardvark Silva\";\nString email = \"aardvark.silva@pagar.me\";\nString documentNumber = \"18152564000105\";\nCustomer customer = new Customer(name, email);\ncustomer.setAddress(address);\ncustomer.setPhone(phone);\ncustomer.setDocumentNumber(documentNumber);\n\nCard card = new Card();\ncard.setNumber(\"4901720080344448\");\ncard.setHolderName(\"Jose da Silva\");\ncard.setExpiresAt(\"1222\");\ncard.setCvv(\"123\");\ncard.save();\n\nCollection splitRules = new ArrayList();\nSplitRule split1 = new SplitRule();\nsplit1.setRecipientId(\"ID_RECEBEDOR\");\nsplit1.setPercentage(50);\nsplit1.setChargeProcessingFee(true);\nsplit1.setLiable(true);\n\nSplitRule split2 = new SplitRule();\nsplit2.setRecipientId(\"ID_RECEBEDOR\");\nsplit2.setPercentage(50);\nsplit2.setChargeProcessingFee(true);\nsplit2.setLiable(true);\n\nsplitRules.add(split1);\nsplitRules.add(split2);\n\nSubscription subscription = new Subscription();\nsubscription.setSplitRules(splitRules);\nsubscription.setCreditCardSubscriptionWithCardId(\"ID_PLANO\", card.getId(), customer);\nsubscription.save();" }, { "language": "javascript", "code": "const pagarme = require(\"pagarme\");\n\npagarme.client.connect({ api_key: \"SUA API KEY\" })\n.then( client => {\n\n client.subscriptions.create({\n plan_id: \"ID DO PLANO\",\n card_number: '4111111111111111',\n card_holder_name: 'Customer Teste',\n card_expiration_date: '1123',\n card_cvv: '123',\n payment_method: 'credit_card',\n customer: {\n document_number: '18152564000105',\n name: 'Customer Teste',\n email: 'customer@email.com',\n born_at: '17071996',\n gender: 'M',\n address: {\n street: 'Rua Fidêncio Ramos',\n complementary: 'apto',\n street_number: '308',\n neighborhood: 'pinheiros',\n city: 'São Paulo',\n state: 'SP',\n zipcode: '04551010',\n country: 'Brasil'\n },\n phone: {\n ddd: '11',\n number: '999887766'\n }\n },\n split_rules: [\n {\n recipient_id: \"ID DO RECEBEDOR\",\n charge_processing_fee: true,\n liable: true,\n percentage: 50\n },\n {\n recipient_id: \"ID DO RECEBEDOR\",\n charge_processing_fee: false,\n liable: false,\n percentage: 50\n }\n ]\n })\n .then( subscription => console.log(subscription), failure => console.log(failure) );\n\n});\n", "name": "JS" }, { "language": "python", "code": "import pagarme\n\npagarme.authentication_key('SUA_API_KEY')\n\nsubscription = pagarme.subscription.create({\n \"card_id\": \"card_cj6qvosem04w3nu6dm20nu8od\",\n \"customer\":{\n \"email\":\"aardvark.silva@gmail.com\",\n \"name\":\"Sir Jorah Mormont\",\n \"document_number\":\"18152564000105\",\n \"address\":{\n \"zipcode\":\"04571020\",\n \"neighborhood\":\"Cidade Moncoes\",\n \"street\":\"R. Dr. Geraldo Campos Moreira\",\n \"street_number\":\"240\"\n },\n \"phone\": {\n \"number\":\"987654321\",\n \"ddd\":\"11\"\n }\n },\n \"split_rules\":[\n {\n \"recipient_id\": \"re_cj6p5tpqj0bp3oi6euostjng1\",\n \"percentage\": \"25\"\n },\n {\n \"recipient_id\": \"re_cj6cbuz041cs5mx6dx2fh5asx\",\n \"percentage\": \"75\"\n }\n ],\n \"payment_method\": \"credit_card\",\n \"plan_id\": \"201836\",\n \"postback_url\": \"http://requestb.in/zyn5obzy\"\n})\n\nprint (subscription)" } ], "samples-languages": [ "curl", "ruby", "php", "csharp", "java", "javascript", "python" ] } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```