Skip to content

Latest commit

 

History

History
94 lines (70 loc) · 2.97 KB

profile-subscriptions.schema.md

File metadata and controls

94 lines (70 loc) · 2.97 KB

Subscription Details Schema

https://ns.adobe.com/xdm/context/profile-subscriptions

Subscription information such as device, environment, and subscriber data.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted fieldgroups/profile/profile-subscriptions.schema.json

Schema Hierarchy

  • Subscription Details https://ns.adobe.com/xdm/context/profile-subscriptions

Subscription Details Example

{
  "xdm:subscriptions": [
    {
      "@id": "https://data.adobe.io/subscriptionid-123",
      "xdm:subscriber": {
        "xdm:firstName": "John",
        "xdm:lastName": "Smith",
        "xdm:courtesyTitle": "Mr.",
        "xdm:birthDay": 1,
        "xdm:birthMonth": 1,
        "xdm:birthYear": 2000,
        "xdm:gender": "male"
      },
      "xdm:device": {
        "xdm:typeId": "TypeIdentifier-111",
        "xdm:typeIdService": "deviceAtlas",
        "xdm:type": "mobile",
        "xdm:manufacturer": "Apple",
        "xdm:model": "iPhone 6",
        "xdm:modelNumber": "A1586",
        "xdm:screenHeight": 667,
        "xdm:screenWidth": 375,
        "xdm:colorDepth": 16777216
      },
      "xdm:SKU": "12345678",
      "xdm:planName": "PS+ 12 Month Membership",
      "xdm:country": "USA",
      "xdm:startDate": "2001-01-01",
      "xdm:endDate": "2002-01-01",
      "xdm:term": 12,
      "xdm:termUnitOfTime": "Month",
      "xdm:status": "active",
      "xdm:contractId": "contractid-123",
      "xdm:paymentMethod": "creditCard",
      "xdm:billingPeriod": "Month",
      "xdm:billingStartDate": "2001-01-01",
      "xdm:paymentStatus": "paid"
    }
  ]
}

Subscription Details Properties

Property Type Required Defined by
xdm:subscriptions Subscription Optional Subscription Details (this schema)
* any Additional this schema allows additional properties

xdm:subscriptions

Subscriptions

Subscriptions that the profile is entitled to including terminated, expired, or exhausted subscriptions.

xdm:subscriptions

  • is optional

  • type: Subscription

  • defined in this schema

xdm:subscriptions Type

Array type: Subscription

All items must be of the type:

  • Subscriptionhttps://ns.adobe.com/xdm/context/subscription