Get Abonnement

The following endpoint can be used to retrieve the details of a Abonnement within the QuickSend application.

Point de terminaison

The following endpoint can be used to retrieve a Abonnement. You must replace the {base_url} , {_id} and {site_id} variables with the appropriate values.

GET

{base_url}/api/v4/site/{site_id}/subscription/{_id}

Demande

Aucun corps n'est requis pour cet appel API

Réponse

Champ

Type

Description

_id

String

L'identifiant de l'abonnement. Ce champ est généré automatiquement par le système et n'est pas requis lors de la création d'un nouvel abonnement, mais il est requis lors de la mise à jour d'un abonnement existant.

externalId

String

Le numéro d'abonnement unique du système/base de données source. Si nous détectons un enregistrement avec le même externalId, il sera mis à jour, sinon il sera ajouté.

frequency

String

La fréquence de facturation.
One of Daily, Weekly, Bi-Weekly, Semi-Monthly, Monthly, Quarterly, Semi-Annually, Yearly

frequencyUnits

Number

Nombre d'unités de fréquence entre les versements. Ex : frequency = Yearly et frequencyUnits = 2 signifie tous les 2 ans.

startDate

Date

La date de début de l'abonnement. Si laissée vide, elle sera définie lorsque le client confirme son mode de paiement. Format = YYYY-MM-DD

numberOfPayments

Number

Le nombre de versements à effectuer. Si laissé vide, l'abonnement se poursuit indéfiniment ou jusqu'à ce qu'il soit fermé manuellement.

status

String

Le statut actuel de l'abonnement.
One of pending, active, paused, failed, closed

webhookUrl

String

L'URL où envoyer les données lorsque certaines actions sont effectuées sur l'abonnement.

attachmentRefs

Une liste de pièces jointes.

customer

String

L'identifiant du client

code

String

Le code unique utilisé dans le lien vers l'abonnement destiné au client.

lines

Les articles facturés par l'abonnement. Une requête qui n'envoie que amount et description obtient une seule ligne récurrente construite à partir de ceux-ci.

totalsRecurring

Les totaux de chaque facture récurrente. total est le montant facturé à chaque période de facturation.

totalsFirstInvoice

Les totaux de la première facture, qui comprend également les lignes ponctuelles.

billToCustomer

String

L' _id du client à facturer.

billTo

Options de remplacement facultatives pour la section Destinataire de la facture. Si billToCustomer est fourni, cet objet sera fusionné avec les informations du client et pourra être utilisé pour remplacer des champs spécifiques. Si billToCustomer n'est pas fourni, les champs de cet objet seront utilisés comme informations de Destinataire sur la facture.

soldTo

Options facultatives pour la section Expédié à / Client de la facture.

deleted

Boolean

Ce drapeau représente si l'enregistrement est supprimé et n'est plus disponible pour être utilisé.

Sample Response

			
{
  "_id": "61f32dc2f62bdc6a48945067",
  "externalId": "439772921",
  "code": "KA39TI45JLMN",
  "customer": "61f32dc2f62bdc6a48951255",
  "billToCustomer": "61f32dc2f62bdc6a48951255",
  "lines": [
    {
      "name": "",
      "description": "Gold+ Plan",
      "qty": 1,
      "unitPrice": 3499,
      "total": 3499,
      "isRecurring": true
    }
  ],
  "totalsRecurring": {
    "taxes": 0,
    "discounts": 0,
    "total": 3499
  },
  "totalsFirstInvoice": {
    "taxes": 0,
    "discounts": 0,
    "total": 3499
  },
  "frequency": "Monthly",
  "frequencyUnits": 1,
  "startDate": "2022-02-23",
  "numberOfPayments": null,
  "status": "active",
  "webhookUrl": "https://yourcompany.com/webhook",
  "attachmentRefs": {
    "internal": [],
    "external": []
  },
  "billTo": {
    "name": "John Doe",
    "attn": "",
    "address": {},
    "emails": [],
    "sms": []
  },
  "soldTo": {
    "name": "John Doe",
    "attn": "",
    "address": {}
  },
  "deleted": false
}