Configuration Sync

Purpose

Configuration Sync creates or updates the catalog from a file or object. It supports features, products, plans, billing cycles, add-ons, credit rules, and overrides on existing subscriptions. It does not import usage events or wallet balances.

Access and initialization

Access

const configSync = subscrio.configSync;

var configSync = subscrio.ConfigSync;

For construction-time configuration, see Subscrio. Sync must be invoked explicitly; merely supplying configuration does not apply it.

Method catalog

Database and connection failures may propagate from any operation. Method-specific errors are listed with each method.

Method details

syncFromFile(filePath: string): Promise<ConfigSyncReport>

// catalog.json contains a ConfigSyncDto document.
const report = await subscrio.configSync.syncFromFile('./catalog.json');
console.log(report.errors);

Task<ConfigSyncReport> SyncFromFileAsync(string filePath)

// catalog.json contains a ConfigSyncDto document.
var report = await subscrio.ConfigSync.SyncFromFileAsync("./catalog.json");
Console.WriteLine(report.Errors.Count);

syncFromJson(config: ConfigSyncDto): Promise<ConfigSyncReport>

const report = await subscrio.configSync.syncFromJson({
  version: '1',
  features: [{ key: 'max-seats', displayName: 'Seats', valueType: 'numeric', defaultValue: '1' }],
  products: [{
    key: 'saas', displayName: 'SaaS', features: ['max-seats'],
    plans: [{
      key: 'pro', displayName: 'Pro', featureValues: { 'max-seats': '20' },
      billingCycles: [{ key: 'pro-monthly', displayName: 'Monthly', durationUnit: 'months', durationValue: 1 }]
    }]
  }]
});
console.log(report.created, report.errors);

Task<ConfigSyncReport> SyncFromJsonAsync(ConfigSyncDto config)

var report = await subscrio.ConfigSync.SyncFromJsonAsync(new ConfigSyncDto(
    Version: "1",
    Features: [new FeatureConfig("max-seats", "Seats", ValueType: "numeric", DefaultValue: "1")],
    Products: [new ProductConfig("saas", "SaaS",
        Features: ["max-seats"],
        Plans: [new PlanConfig("pro", "Pro",
            FeatureValues: new() { ["max-seats"] = "20" },
            BillingCycles: [new BillingCycleConfig("pro-monthly", "Monthly", DurationValue: 1, DurationUnit: "months")])])]
));
Console.WriteLine($"Created plans: {report.Created.Plans}, errors: {report.Errors.Count}");

exportConfig(subscriptionKeys?: string[]): Promise<ConfigSyncDto>

const config = await subscrio.configSync.exportConfig();
console.log(config.products.length);

Task<ConfigSyncDto> ExportConfigAsync(IEnumerable<string>? subscriptionKeys)

var config = await subscrio.ConfigSync.ExportConfigAsync();
Console.WriteLine(config.Products.Count);

Data types

Required means an input must be supplied, or a returned property is guaranteed present. Nested keys inherit their parent product or plan; keys remain globally unique. Refer to the corresponding object page for field validation limits.

Transition targets must belong to the same product. TypeScript validates that the target is present in this configuration's nested billing cycles. When an existing plan is included without a transition target, synchronization clears its saved target. Include the target to preserve it; omitting the plan entirely leaves it unchanged.

Related guides

• Subscrio: initialization and initial configuration.
• Features: values and metering settings.
• Add-ons: feature contributions.
• Credits: grant and consumption rules.
• Subscriptions: override lifetime and restrictions.