Parâmetro obrigatório usado para criar uma assinatura. Designa a regra da assinatura a ser criada.
O valor esperado neste parâmetro é um string de símbolos conforme a especificação iCalendar, ou Internet Calendar, descrita na RFC5545 (ver http://tools.ietf.org/html/rfc5545).
Esta especificação permite, dentro de outras coisas, definir regras complexas de assinatura, via a propriedade RRULE.
Por razões técnicas. não é possível definir períodos de assinatura inferiores a um dia.
As palavras chaves SECONDLY" / "MINUTELY" /
"HOURLY não são levados 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 mês não tiver dia 30, então ele levará em conta o dia 29, e assim por diante até o dia 28.
Uma 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 trimestrais, 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 definir uma assinatura todas as semanas, na segunda: RRULE:FREQ=WEEKLY;BYDAY=MO
As parcelas serão nas segundas. Atenção a primeira parcela será na próxima seunda.
- Para definir uma assinatura todas as semanas: RRULE:FREQ=WEEKLY
As parcelas serão no mesmo dia se a data de efeito for posicionada em “hoje” e depois a cada 7 dias.
- Para definir uma assinatura a cada duas semanas, nas segundas, com o limite de 4 ocorrências: RRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=4;BYDAY=MO
- Para definir uma assinatura a cada duas semanas, hoje e a cada 7 dias: RRULE:FREQ=WEEKLY;INTERVAL=2;
-
Para maiores detalhes e exemplos, você pode consultar o site http://recurrance.sourceforge.net/.
Campo de entrada e de saída, retornado na resposta (IPN e URL de retorno).
|