EDeduzz
MyEduzz

Obtém os detalhes das assinaturas por intervalo de data

Changed on
get/myeduzz/v1/subscriptions

Request

Query parameters

pagenumber

Página atual

itemsPerPagenumber

Quantidade de itens por página

startDatestring date-time

Data de início do intervalo de busca (inclusive)

endDatestring date-time

Data de término do intervalo de busca (inclusive)

filterBy'creation' | 'update'

Filtra os resultados por tipo de alteração (criação ou atualização)

Response

Detalhes da assinatura

idstring required

Id da assinatura

createdAtstring date-time required

Data de criação da assinatura

updatedAtstring date-time required

Data de atualização da assinatura

status'upToDate' | 'awaitingPayment' | 'late' | 'canceled' | 'defaulter' | 'suspended' | 'trial' | 'finished' | 'free' required

Status da assinatura

firstInvoiceIdstring required

Id da primeira fatura da assinatura

isFiniteboolean required

Indica se a assinatura é finita

isUnlimitedInstallmentsboolean required

Indica se a assinatura é parcelamento sem limites

hasNegotiationboolean required

Indica se a assinatura possui alguma fatura negociada

Example response

{
  "products": [
    {
      "deliveries": [
        "files"
      ]
    }
  ]
}

Changes

  • f93320e6a417Revision changes
    • info

      the query request parameter endDate became optional

    • info

      the query request parameter filterBy became optional

    • info

      the query request parameter page became optional

    • info

      the query request parameter startDate became optional

  • 8e41c62b53a8Revision changes
    • breaking

      the query request parameter filterBy was restricted to a list of enum values

    • breaking

      the query request parameter endDate became required

    • breaking

      the query request parameter filterBy became required

    • breaking

      the query request parameter page became required

    • breaking

      the query request parameter startDate became required

    • breaking

      added the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ to the query request parameter endDate

    • breaking

      added the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ to the query request parameter startDate

    • breaking

      for the query request parameter endDate, the format changed from no format to date-time

    • breaking

      for the query request parameter page, the type changed from string to number

    • breaking

      for the query request parameter startDate, the format changed from no format to date-time

    • info

      added the new optional query request parameter itemsPerPage

    • info

      added the new enum value creation to the query request parameter filterBy

    • info

      added the new enum value update to the query request parameter filterBy