subscriptionRequest

O objeto subscriptionRequest permite transmitir informações sobre a assinatura.

Possui os atributos seguintes:

Atributo Requisito Formato
effectDate

Data de vigência no formato W3C.

Exemplo : 2016-07-16T19:20Z

A data não pode ser vencida.

dateTime ans..40
amount

Valor da assinatura na sua menor unidade monetária.

n..12
currency

Código da moeda (norma ISO 4217 Ex: 986 para o real do Brasil (BRL).

n3
initialAmount

Valor das parcelas da assinatura (na sua menor unidade monetar) para a ou as primeiras parcelas se estas últimas forem diferentes do valor da assinatura amount.

n..12
initialAmountNumber

Quantidade de parcelas para as quais haverá que aplicar o valor initialAmount.

Este atributo se torna obrigatório se initialAmount é valorizado.

int
rrule

Descrição da regra da assinatura.

O valor esperado neste atributo é um string de símbolos conforme a especificação iCalendar, ou Internet Calendar, descrita na RFC5545 (ver http://tools.ietf.org/html/rfc5545).

Por razões técnicas. não for possível definir períodos de assinatura inferiores a um dia.

As palavras chaves SECONDLY" / "MINUTELY" / "HOURLY não são levadas em conta.

Exemplos:
  • Para definir parcelas de pagamento que ocorrem o último dia de cada mês, durante 12 meses, a regra se escreve:

    RRULE:FREQ=MONTHLY;BYMONTHDAY=28,29,30,31;BYSETPOS=-1;COUNT=12

    Esta regra significa que se o mês corrente não contém um dia 31, então o motor levará em conta o dia 30. Se o dia 30 não existe, então ele levará em conta o dia 29, e assim por diante até o dia 28.

    Outra versão desta regra é: RRULE:FREQ=MONTHLY;COUNT=5;BYMONTHDAY=-1

  • Para definir parcelas de pagamento que ocorrem o dia 10 de cada mês, durante 12 meses, a regra de assinatura se escreve da seguinte forma: RRULE:FREQ=MONTHLY;COUNT=12;BYMONTHDAY=10

  • Para definir parcelas de pagamento que ocorrem todo trimestre, até o 31/12/2016: RRULE:FREQ=YEARLY;BYMONTHDAY=-1;BYMONTH=1,4,7,10;UNTIL=20161231

    As parcelas ocorrerão todo dia 1° de janeiro, abril, julho e outubro. A quantidade total deles depende da data de início da assinatura (ver parâmetro vads_sub_effect_date).

    Para maiores detalhes e exemplos, você pode consultar o site http://recurrance.sourceforge.net/.

string
subscriptionId

Código da assinatura.

  string
description

Descrição da assinatura.

  string