Help Page Home

SUBSCRIPTIONS v1.0

POST api/v1.0/{tenant}/subscription

Add a new subscription in the database


Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

The requested API version

 string

Required

Default value is 1.0
tenant

string

None.

Body Parameters

Data fields

SubscriptionModelCreateSimple
NameDescriptionTypeAdditional information
societeId

Id de la société rattachée

 integer

None.
clientId

Id du client abonné

 integer

None.
payeurId

Id du client payeur

 integer

None.
supportId

Id du support

 integer

None.
tarifId

Id du tarif

 integer

None.
paiement

Créer le règlement avec l'abonnement

 boolean

None.
source

Nom de la source qui ajoute l'abonnement

 string

None.
factureMail

Envoyer la facture par mail au client payeur

 boolean

None.
modePaiementId

Id du mode de paiement

 integer

None.
couplesCodes

Liste des codes des couplés (exemples : CER / LAI / VIA / AVI / POR / FL / VIG / PAT / CHE ...) Se référer à la base de donnée pour identifier les codes des couplés correspondant.

 Collection of string

None.

Request Formats

application/json, text/json
Sample: 
{
  "societeId": 1,
  "clientId": 2,
  "payeurId": 3,
  "supportId": 4,
  "tarifId": 5,
  "paiement": true,
  "source": "sample string 7",
  "factureMail": true,
  "modePaiementId": 9,
  "couplesCodes": [
    "sample string 1",
    "sample string 2"
  ]
}
application/xml, text/xml
Sample: 
<SubscriptionModelCreateSimple xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ReuGAD.API.Models">
  <clientId>2</clientId>
  <couplesCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </couplesCodes>
  <factureMail>true</factureMail>
  <modePaiementId>9</modePaiementId>
  <paiement>true</paiement>
  <payeurId>3</payeurId>
  <societeId>1</societeId>
  <source>sample string 7</source>
  <supportId>4</supportId>
  <tarifId>5</tarifId>
</SubscriptionModelCreateSimple>
application/x-www-form-urlencoded
Sample:

Sample not available.


Response Information

Resource Description

The subscription data with created id

APIReturnModelOfSubscriptionModel
NameDescriptionTypeAdditional information
data

SubscriptionModel

None.
state

Etat de la réponse

 string

None.
operation

Type de la réponse

 string

None.
result

Résultat de la réponse

 Result

None.
link

Url du lien

 string

None.

Response Information

Response body formats

application/json, text/json
Sample: 
{
  "data": {
    "id": 1,
    "societeId": 2,
    "client": {
      "id": 1,
      "numero": "sample string 2",
      "nom": "sample string 3",
      "email": "sample string 4"
    },
    "payeur": {
      "id": 1,
      "numero": "sample string 2",
      "nom": "sample string 3",
      "email": "sample string 4"
    },
    "contratOrdre": "sample string 3",
    "typeCde": "sample string 4",
    "typeAbo": "sample string 5",
    "statut": "sample string 6",
    "support": {
      "id": 1,
      "code": "sample string 2",
      "libelle": "sample string 3"
    },
    "offre": {
      "id": 1,
      "code": "sample string 2",
      "libelle": "sample string 3"
    },
    "tarif": {
      "id": 1,
      "code": "sample string 2",
      "libelle": "sample string 3"
    },
    "modeDistri": {
      "id": 1,
      "code": "sample string 2",
      "libelle": "sample string 3"
    },
    "numDebut": 7,
    "numFin": 8,
    "numDateDebut": "2026-01-02T14:34:09.7919382+00:00",
    "numDateFin": "2026-01-02T14:34:09.7919382+00:00",
    "nbNumeros": 9,
    "nbReste": 10,
    "nbExemplaires": 11,
    "dateAbonnement": "2026-01-02T14:34:09.7919382+00:00",
    "dateReabonnement": "2026-01-02T14:34:09.7919382+00:00",
    "dateRelance": "2026-01-02T14:34:09.7919382+00:00",
    "nbRelance": 1,
    "montantTTC": 13.0,
    "param1": {
      "id": 1,
      "code": "sample string 2",
      "libelle": "sample string 3"
    },
    "param2": {
      "id": 1,
      "code": "sample string 2",
      "libelle": "sample string 3"
    },
    "param3": {
      "id": 1,
      "code": "sample string 2",
      "libelle": "sample string 3"
    },
    "planWeb": "sample string 14",
    "couples": [
      {
        "code": "sample string 1",
        "nom": "sample string 2",
        "nombre": 3
      },
      {
        "code": "sample string 1",
        "nom": "sample string 2",
        "nombre": 3
      }
    ],
    "mails": [
      {
        "email": "sample string 1"
      },
      {
        "email": "sample string 1"
      }
    ]
  },
  "state": "sample string 1",
  "operation": "sample string 2",
  "result": {
    "code": 100,
    "message": "sample string 1",
    "detail": "sample string 2"
  },
  "link": "sample string 3"
}
application/xml, text/xml
Sample: 
<APIReturnModelOfSubscriptionModel3JrgOwLl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ReuGAD.API.Models.APIResponse">
  <link xmlns="http://schemas.datacontract.org/2004/07/ReuGAD.API.Models">sample string 3</link>
  <operation>sample string 2</operation>
  <result>
    <code>Continue</code>
    <detail>sample string 2</detail>
    <message>sample string 1</message>
  </result>
  <state>sample string 1</state>
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ReuGAD.API.Models">
    <d2p1:client>
      <d2p1:email>sample string 4</d2p1:email>
      <d2p1:id>1</d2p1:id>
      <d2p1:nom>sample string 3</d2p1:nom>
      <d2p1:numero>sample string 2</d2p1:numero>
    </d2p1:client>
    <d2p1:contratOrdre>sample string 3</d2p1:contratOrdre>
    <d2p1:couples>
      <d2p1:SubscriptionCouplesModel>
        <d2p1:code>sample string 1</d2p1:code>
        <d2p1:nom>sample string 2</d2p1:nom>
        <d2p1:nombre>3</d2p1:nombre>
      </d2p1:SubscriptionCouplesModel>
      <d2p1:SubscriptionCouplesModel>
        <d2p1:code>sample string 1</d2p1:code>
        <d2p1:nom>sample string 2</d2p1:nom>
        <d2p1:nombre>3</d2p1:nombre>
      </d2p1:SubscriptionCouplesModel>
    </d2p1:couples>
    <d2p1:dateAbonnement>2026-01-02T14:34:09.7919382+00:00</d2p1:dateAbonnement>
    <d2p1:dateReabonnement>2026-01-02T14:34:09.7919382+00:00</d2p1:dateReabonnement>
    <d2p1:dateRelance>2026-01-02T14:34:09.7919382+00:00</d2p1:dateRelance>
    <d2p1:id>1</d2p1:id>
    <d2p1:mails>
      <d2p1:SubscriptionMailModel>
        <d2p1:email>sample string 1</d2p1:email>
      </d2p1:SubscriptionMailModel>
      <d2p1:SubscriptionMailModel>
        <d2p1:email>sample string 1</d2p1:email>
      </d2p1:SubscriptionMailModel>
    </d2p1:mails>
    <d2p1:modeDistri>
      <d2p1:code>sample string 2</d2p1:code>
      <d2p1:id>1</d2p1:id>
      <d2p1:libelle>sample string 3</d2p1:libelle>
    </d2p1:modeDistri>
    <d2p1:montantTTC>13</d2p1:montantTTC>
    <d2p1:nbExemplaires>11</d2p1:nbExemplaires>
    <d2p1:nbNumeros>9</d2p1:nbNumeros>
    <d2p1:nbRelance>1</d2p1:nbRelance>
    <d2p1:nbReste>10</d2p1:nbReste>
    <d2p1:numDateDebut>2026-01-02T14:34:09.7919382+00:00</d2p1:numDateDebut>
    <d2p1:numDateFin>2026-01-02T14:34:09.7919382+00:00</d2p1:numDateFin>
    <d2p1:numDebut>7</d2p1:numDebut>
    <d2p1:numFin>8</d2p1:numFin>
    <d2p1:offre>
      <d2p1:code>sample string 2</d2p1:code>
      <d2p1:id>1</d2p1:id>
      <d2p1:libelle>sample string 3</d2p1:libelle>
    </d2p1:offre>
    <d2p1:param1>
      <d2p1:code>sample string 2</d2p1:code>
      <d2p1:id>1</d2p1:id>
      <d2p1:libelle>sample string 3</d2p1:libelle>
    </d2p1:param1>
    <d2p1:param2>
      <d2p1:code>sample string 2</d2p1:code>
      <d2p1:id>1</d2p1:id>
      <d2p1:libelle>sample string 3</d2p1:libelle>
    </d2p1:param2>
    <d2p1:param3>
      <d2p1:code>sample string 2</d2p1:code>
      <d2p1:id>1</d2p1:id>
      <d2p1:libelle>sample string 3</d2p1:libelle>
    </d2p1:param3>
    <d2p1:payeur>
      <d2p1:email>sample string 4</d2p1:email>
      <d2p1:id>1</d2p1:id>
      <d2p1:nom>sample string 3</d2p1:nom>
      <d2p1:numero>sample string 2</d2p1:numero>
    </d2p1:payeur>
    <d2p1:planWeb>sample string 14</d2p1:planWeb>
    <d2p1:societeId>2</d2p1:societeId>
    <d2p1:statut>sample string 6</d2p1:statut>
    <d2p1:support>
      <d2p1:code>sample string 2</d2p1:code>
      <d2p1:id>1</d2p1:id>
      <d2p1:libelle>sample string 3</d2p1:libelle>
    </d2p1:support>
    <d2p1:tarif>
      <d2p1:code>sample string 2</d2p1:code>
      <d2p1:id>1</d2p1:id>
      <d2p1:libelle>sample string 3</d2p1:libelle>
    </d2p1:tarif>
    <d2p1:typeAbo>sample string 5</d2p1:typeAbo>
    <d2p1:typeCde>sample string 4</d2p1:typeCde>
  </data>
</APIReturnModelOfSubscriptionModel3JrgOwLl>

REUC'API v1.0 - Copyright 2026 Réussir ©